Class: AWSCDK::CloudTrail::CfnEventDataStore

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSCloudtrail::IEventDataStoreRef
Defined in:
cloud_trail/cfn_event_data_store.rb

Overview

Creates a new event data store.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnEventDataStore

Create a new AWS::CloudTrail::EventDataStore.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::CloudTrail::CfnEventDataStoreProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'cloud_trail/cfn_event_data_store.rb', line 18

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudTrail::CfnEventDataStoreProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5FdmVudERhdGFTdG9yZVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_event_data_store(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'cloud_trail/cfn_event_data_store.rb', line 90

def self.arn_for_event_data_store(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbG91ZHRyYWlsLklFdmVudERhdGFTdG9yZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudtrail.CfnEventDataStore", "arnForEventDataStore", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


197
198
199
 
# File 'cloud_trail/cfn_event_data_store.rb', line 197

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudtrail.CfnEventDataStore", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_event_data_store(x) ⇒ Boolean

Checks whether the given object is a CfnEventDataStore.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


99
100
101
102
 
# File 'cloud_trail/cfn_event_data_store.rb', line 99

def self.is_cfn_event_data_store(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudtrail.CfnEventDataStore", "isCfnEventDataStore", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'cloud_trail/cfn_event_data_store.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_created_timestamp => { kind: :property, name: "attrCreatedTimestamp", is_optional: false },
    :attr_event_data_store_arn => { kind: :property, name: "attrEventDataStoreArn", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_updated_timestamp => { kind: :property, name: "attrUpdatedTimestamp", is_optional: false },
    :event_data_store_ref => { kind: :property, name: "eventDataStoreRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :advanced_event_selectors => { kind: :property, name: "advancedEventSelectors", is_optional: true },
    :billing_mode => { kind: :property, name: "billingMode", is_optional: true },
    :context_key_selectors => { kind: :property, name: "contextKeySelectors", is_optional: true },
    :federation_enabled => { kind: :property, name: "federationEnabled", is_optional: true },
    :federation_role_arn => { kind: :property, name: "federationRoleArn", is_optional: true },
    :ingestion_enabled => { kind: :property, name: "ingestionEnabled", is_optional: true },
    :insights_destination => { kind: :property, name: "insightsDestination", is_optional: true },
    :insight_selectors => { kind: :property, name: "insightSelectors", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :max_event_size => { kind: :property, name: "maxEventSize", is_optional: true },
    :multi_region_enabled => { kind: :property, name: "multiRegionEnabled", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :organization_enabled => { kind: :property, name: "organizationEnabled", is_optional: true },
    :retention_period => { kind: :property, name: "retentionPeriod", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :termination_protection_enabled => { kind: :property, name: "terminationProtectionEnabled", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



472
473
474
475
 
# File 'cloud_trail/cfn_event_data_store.rb', line 472

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



484
485
486
487
 
# File 'cloud_trail/cfn_event_data_store.rb', line 484

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



494
495
496
497
 
# File 'cloud_trail/cfn_event_data_store.rb', line 494

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



505
506
507
508
509
 
# File 'cloud_trail/cfn_event_data_store.rb', line 505

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


562
563
564
565
566
 
# File 'cloud_trail/cfn_event_data_store.rb', line 562

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



572
573
574
575
 
# File 'cloud_trail/cfn_event_data_store.rb', line 572

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



584
585
586
587
588
 
# File 'cloud_trail/cfn_event_data_store.rb', line 584

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#advanced_event_selectors ⇒ AWSCDK::IResolvable, ...

The advanced event selectors to use to select the events for the data store.

Returns:



246
247
248
 
# File 'cloud_trail/cfn_event_data_store.rb', line 246

def advanced_event_selectors()
  jsii_get_property("advancedEventSelectors")
end

#advanced_event_selectors=(value) ⇒ Object 



250
251
252
253
 
# File 'cloud_trail/cfn_event_data_store.rb', line 250

def advanced_event_selectors=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5FdmVudERhdGFTdG9yZS5BZHZhbmNlZEV2ZW50U2VsZWN0b3JQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "advancedEventSelectors") unless value.nil?
  jsii_set_property("advancedEventSelectors", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



597
598
599
600
 
# File 'cloud_trail/cfn_event_data_store.rb', line 597

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



619
620
621
622
623
624
 
# File 'cloud_trail/cfn_event_data_store.rb', line 619

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_created_timestamp ⇒ String

Ref returns the time stamp of the creation of the event data store, such as 1248496624 .

Returns:

  • (String) 


204
205
206
 
# File 'cloud_trail/cfn_event_data_store.rb', line 204

def attr_created_timestamp()
  jsii_get_property("attrCreatedTimestamp")
end

#attr_event_data_store_arn ⇒ String

Ref returns the ARN of the CloudTrail event data store, such as arn:aws:cloudtrail:us-east-1:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE .

Returns:

  • (String) 


211
212
213
 
# File 'cloud_trail/cfn_event_data_store.rb', line 211

def attr_event_data_store_arn()
  jsii_get_property("attrEventDataStoreArn")
end

#attr_status ⇒ String

Ref returns the status of the event data store, such as ENABLED .

Returns:

  • (String) 


218
219
220
 
# File 'cloud_trail/cfn_event_data_store.rb', line 218

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_updated_timestamp ⇒ String

Ref returns the time stamp that updates were made to an event data store, such as 1598296624 .

Returns:

  • (String) 


225
226
227
 
# File 'cloud_trail/cfn_event_data_store.rb', line 225

def attr_updated_timestamp()
  jsii_get_property("attrUpdatedTimestamp")
end

#billing_mode ⇒ String?

The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

Returns:

  • (String, nil) 


258
259
260
 
# File 'cloud_trail/cfn_event_data_store.rb', line 258

def billing_mode()
  jsii_get_property("billingMode")
end

#billing_mode=(value) ⇒ Object 



262
263
264
265
 
# File 'cloud_trail/cfn_event_data_store.rb', line 262

def billing_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "billingMode") unless value.nil?
  jsii_set_property("billingMode", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



150
151
152
 
# File 'cloud_trail/cfn_event_data_store.rb', line 150

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


155
156
157
 
# File 'cloud_trail/cfn_event_data_store.rb', line 155

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


628
629
630
631
 
# File 'cloud_trail/cfn_event_data_store.rb', line 628

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


160
161
162
 
# File 'cloud_trail/cfn_event_data_store.rb', line 160

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


167
168
169
 
# File 'cloud_trail/cfn_event_data_store.rb', line 167

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#context_key_selectors ⇒ AWSCDK::IResolvable, ...

The list of context key selectors that are configured for the event data store.

Returns:



270
271
272
 
# File 'cloud_trail/cfn_event_data_store.rb', line 270

def context_key_selectors()
  jsii_get_property("contextKeySelectors")
end

#context_key_selectors=(value) ⇒ Object 



274
275
276
277
 
# File 'cloud_trail/cfn_event_data_store.rb', line 274

def context_key_selectors=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5FdmVudERhdGFTdG9yZS5Db250ZXh0S2V5U2VsZWN0b3JQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "contextKeySelectors") unless value.nil?
  jsii_set_property("contextKeySelectors", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


112
113
114
 
# File 'cloud_trail/cfn_event_data_store.rb', line 112

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



172
173
174
 
# File 'cloud_trail/cfn_event_data_store.rb', line 172

def env()
  jsii_get_property("env")
end

#event_data_store_ref ⇒ AWSCDK::Interfaces::AWSCloudtrail::EventDataStoreReference

A reference to a EventDataStore resource.

Returns:



232
233
234
 
# File 'cloud_trail/cfn_event_data_store.rb', line 232

def event_data_store_ref()
  jsii_get_property("eventDataStoreRef")
end

#federation_enabled ⇒ Boolean, ...

Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.

Returns:



282
283
284
 
# File 'cloud_trail/cfn_event_data_store.rb', line 282

def federation_enabled()
  jsii_get_property("federationEnabled")
end

#federation_enabled=(value) ⇒ Object 



286
287
288
289
 
# File 'cloud_trail/cfn_event_data_store.rb', line 286

def federation_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "federationEnabled") unless value.nil?
  jsii_set_property("federationEnabled", value)
end

#federation_role_arn ⇒ String?

If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.

Returns:

  • (String, nil) 


294
295
296
 
# File 'cloud_trail/cfn_event_data_store.rb', line 294

def federation_role_arn()
  jsii_get_property("federationRoleArn")
end

#federation_role_arn=(value) ⇒ Object 



298
299
300
301
 
# File 'cloud_trail/cfn_event_data_store.rb', line 298

def federation_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "federationRoleArn") unless value.nil?
  jsii_set_property("federationRoleArn", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



641
642
643
644
645
 
# File 'cloud_trail/cfn_event_data_store.rb', line 641

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



652
653
654
655
 
# File 'cloud_trail/cfn_event_data_store.rb', line 652

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#ingestion_enabled ⇒ Boolean, ...

Specifies whether the event data store should start ingesting live events.

Returns:



306
307
308
 
# File 'cloud_trail/cfn_event_data_store.rb', line 306

def ingestion_enabled()
  jsii_get_property("ingestionEnabled")
end

#ingestion_enabled=(value) ⇒ Object 



310
311
312
313
 
# File 'cloud_trail/cfn_event_data_store.rb', line 310

def ingestion_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "ingestionEnabled") unless value.nil?
  jsii_set_property("ingestionEnabled", value)
end

#insight_selectors ⇒ AWSCDK::IResolvable, ...

A JSON string that contains the Insights types you want to log on an event data store.

Returns:



330
331
332
 
# File 'cloud_trail/cfn_event_data_store.rb', line 330

def insight_selectors()
  jsii_get_property("insightSelectors")
end

#insight_selectors=(value) ⇒ Object 



334
335
336
337
 
# File 'cloud_trail/cfn_event_data_store.rb', line 334

def insight_selectors=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5FdmVudERhdGFTdG9yZS5JbnNpZ2h0U2VsZWN0b3JQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "insightSelectors") unless value.nil?
  jsii_set_property("insightSelectors", value)
end

#insights_destination ⇒ String?

The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.

Returns:

  • (String, nil) 


318
319
320
 
# File 'cloud_trail/cfn_event_data_store.rb', line 318

def insights_destination()
  jsii_get_property("insightsDestination")
end

#insights_destination=(value) ⇒ Object 



322
323
324
325
 
# File 'cloud_trail/cfn_event_data_store.rb', line 322

def insights_destination=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "insightsDestination") unless value.nil?
  jsii_set_property("insightsDestination", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



722
723
724
725
 
# File 'cloud_trail/cfn_event_data_store.rb', line 722

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_id ⇒ String?

Specifies the AWS key ID to use to encrypt the events delivered by CloudTrail.

Returns:

  • (String, nil) 


342
343
344
 
# File 'cloud_trail/cfn_event_data_store.rb', line 342

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



346
347
348
349
 
# File 'cloud_trail/cfn_event_data_store.rb', line 346

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


124
125
126
 
# File 'cloud_trail/cfn_event_data_store.rb', line 124

def logical_id()
  jsii_get_property("logicalId")
end

#max_event_size ⇒ String?

The maximum allowed size for events to be stored in the specified event data store.

Returns:

  • (String, nil) 


354
355
356
 
# File 'cloud_trail/cfn_event_data_store.rb', line 354

def max_event_size()
  jsii_get_property("maxEventSize")
end

#max_event_size=(value) ⇒ Object 



358
359
360
361
 
# File 'cloud_trail/cfn_event_data_store.rb', line 358

def max_event_size=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "maxEventSize") unless value.nil?
  jsii_set_property("maxEventSize", value)
end

#multi_region_enabled ⇒ Boolean, ...

Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

Returns:



366
367
368
 
# File 'cloud_trail/cfn_event_data_store.rb', line 366

def multi_region_enabled()
  jsii_get_property("multiRegionEnabled")
end

#multi_region_enabled=(value) ⇒ Object 



370
371
372
373
 
# File 'cloud_trail/cfn_event_data_store.rb', line 370

def multi_region_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "multiRegionEnabled") unless value.nil?
  jsii_set_property("multiRegionEnabled", value)
end

#name ⇒ String?

The name of the event data store.

Returns:

  • (String, nil) 


378
379
380
 
# File 'cloud_trail/cfn_event_data_store.rb', line 378

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



382
383
384
385
 
# File 'cloud_trail/cfn_event_data_store.rb', line 382

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


107
108
109
 
# File 'cloud_trail/cfn_event_data_store.rb', line 107

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



663
664
665
 
# File 'cloud_trail/cfn_event_data_store.rb', line 663

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



670
671
672
 
# File 'cloud_trail/cfn_event_data_store.rb', line 670

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#organization_enabled ⇒ Boolean, ...

Specifies whether an event data store collects events logged for an organization in AWS Organizations .

Returns:



390
391
392
 
# File 'cloud_trail/cfn_event_data_store.rb', line 390

def organization_enabled()
  jsii_get_property("organizationEnabled")
end

#organization_enabled=(value) ⇒ Object 



394
395
396
397
 
# File 'cloud_trail/cfn_event_data_store.rb', line 394

def organization_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "organizationEnabled") unless value.nil?
  jsii_set_property("organizationEnabled", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



463
464
465
466
 
# File 'cloud_trail/cfn_event_data_store.rb', line 463

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


143
144
145
 
# File 'cloud_trail/cfn_event_data_store.rb', line 143

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



681
682
683
684
 
# File 'cloud_trail/cfn_event_data_store.rb', line 681

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


688
689
690
691
 
# File 'cloud_trail/cfn_event_data_store.rb', line 688

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



698
699
700
701
702
 
# File 'cloud_trail/cfn_event_data_store.rb', line 698

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#retention_period ⇒ Numeric?

The retention period of the event data store, in days.

Returns:

  • (Numeric, nil) 


402
403
404
 
# File 'cloud_trail/cfn_event_data_store.rb', line 402

def retention_period()
  jsii_get_property("retentionPeriod")
end

#retention_period=(value) ⇒ Object 



406
407
408
409
 
# File 'cloud_trail/cfn_event_data_store.rb', line 406

def retention_period=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retentionPeriod") unless value.nil?
  jsii_set_property("retentionPeriod", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



707
708
709
 
# File 'cloud_trail/cfn_event_data_store.rb', line 707

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



133
134
135
 
# File 'cloud_trail/cfn_event_data_store.rb', line 133

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



239
240
241
 
# File 'cloud_trail/cfn_event_data_store.rb', line 239

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A list of tags.

Returns:



414
415
416
 
# File 'cloud_trail/cfn_event_data_store.rb', line 414

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



418
419
420
421
422
 
# File 'cloud_trail/cfn_event_data_store.rb', line 418

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#termination_protection_enabled ⇒ Boolean, ...

Specifies whether termination protection is enabled for the event data store.

Returns:



427
428
429
 
# File 'cloud_trail/cfn_event_data_store.rb', line 427

def termination_protection_enabled()
  jsii_get_property("terminationProtectionEnabled")
end

#termination_protection_enabled=(value) ⇒ Object 



431
432
433
434
 
# File 'cloud_trail/cfn_event_data_store.rb', line 431

def termination_protection_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "terminationProtectionEnabled") unless value.nil?
  jsii_set_property("terminationProtectionEnabled", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



439
440
441
 
# File 'cloud_trail/cfn_event_data_store.rb', line 439

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'cloud_trail/cfn_event_data_store.rb', line 180

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


190
191
192
 
# File 'cloud_trail/cfn_event_data_store.rb', line 190

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


713
714
715
716
 
# File 'cloud_trail/cfn_event_data_store.rb', line 713

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


452
453
454
455
456
457
 
# File 'cloud_trail/cfn_event_data_store.rb', line 452

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end