Class: AWSCDK::CloudTrail::CfnEventDataStoreProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_trail/cfn_event_data_store_props.rb

Overview

Properties for defining a CfnEventDataStore.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(advanced_event_selectors: nil, billing_mode: nil, context_key_selectors: nil, federation_enabled: nil, federation_role_arn: nil, ingestion_enabled: nil, insights_destination: nil, insight_selectors: nil, kms_key_id: nil, max_event_size: nil, multi_region_enabled: nil, name: nil, organization_enabled: nil, retention_period: nil, tags: nil, termination_protection_enabled: nil) ⇒ CfnEventDataStoreProps

Returns a new instance of CfnEventDataStoreProps.

Parameters:

  • advanced_event_selectors (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CloudTrail::CfnEventDataStore::AdvancedEventSelectorProperty>, nil) (defaults to: nil) —

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

  • billing_mode (String, nil) (defaults to: nil) —

    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.

  • context_key_selectors (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CloudTrail::CfnEventDataStore::ContextKeySelectorProperty>, nil) (defaults to: nil) —

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

  • federation_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    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.

  • federation_role_arn (String, nil) (defaults to: nil) —

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

  • ingestion_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • insights_destination (String, nil) (defaults to: nil) —

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

  • insight_selectors (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CloudTrail::CfnEventDataStore::InsightSelectorProperty>, nil) (defaults to: nil) —

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

  • kms_key_id (String, nil) (defaults to: nil) —

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

  • max_event_size (String, nil) (defaults to: nil) —

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

  • multi_region_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • name (String, nil) (defaults to: nil) —

    The name of the event data store.

  • organization_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • retention_period (Numeric, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of tags.

  • termination_protection_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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



25
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
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 25

def initialize(advanced_event_selectors: nil, billing_mode: nil, context_key_selectors: nil, federation_enabled: nil, federation_role_arn: nil, ingestion_enabled: nil, insights_destination: nil, insight_selectors: nil, kms_key_id: nil, max_event_size: nil, multi_region_enabled: nil, name: nil, organization_enabled: nil, retention_period: nil, tags: nil, termination_protection_enabled: nil)
  @advanced_event_selectors = advanced_event_selectors
  Jsii::Type.check_type(@advanced_event_selectors, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5FdmVudERhdGFTdG9yZS5BZHZhbmNlZEV2ZW50U2VsZWN0b3JQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "advancedEventSelectors") unless @advanced_event_selectors.nil?
  @billing_mode = billing_mode
  Jsii::Type.check_type(@billing_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "billingMode") unless @billing_mode.nil?
  @context_key_selectors = context_key_selectors
  Jsii::Type.check_type(@context_key_selectors, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5FdmVudERhdGFTdG9yZS5Db250ZXh0S2V5U2VsZWN0b3JQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "contextKeySelectors") unless @context_key_selectors.nil?
  @federation_enabled = federation_enabled
  Jsii::Type.check_type(@federation_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "federationEnabled") unless @federation_enabled.nil?
  @federation_role_arn = federation_role_arn
  Jsii::Type.check_type(@federation_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "federationRoleArn") unless @federation_role_arn.nil?
  @ingestion_enabled = ingestion_enabled
  Jsii::Type.check_type(@ingestion_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "ingestionEnabled") unless @ingestion_enabled.nil?
  @insights_destination = insights_destination
  Jsii::Type.check_type(@insights_destination, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "insightsDestination") unless @insights_destination.nil?
  @insight_selectors = insight_selectors
  Jsii::Type.check_type(@insight_selectors, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5FdmVudERhdGFTdG9yZS5JbnNpZ2h0U2VsZWN0b3JQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "insightSelectors") unless @insight_selectors.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @max_event_size = max_event_size
  Jsii::Type.check_type(@max_event_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "maxEventSize") unless @max_event_size.nil?
  @multi_region_enabled = multi_region_enabled
  Jsii::Type.check_type(@multi_region_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "multiRegionEnabled") unless @multi_region_enabled.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @organization_enabled = organization_enabled
  Jsii::Type.check_type(@organization_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "organizationEnabled") unless @organization_enabled.nil?
  @retention_period = retention_period
  Jsii::Type.check_type(@retention_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retentionPeriod") unless @retention_period.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @termination_protection_enabled = termination_protection_enabled
  Jsii::Type.check_type(@termination_protection_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "terminationProtectionEnabled") unless @termination_protection_enabled.nil?
end

Instance Attribute Details

#advanced_event_selectors ⇒ AWSCDK::IResolvable, ... (readonly)

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

You can configure up to five advanced event selectors for each event data store.

For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see Create an event data store for AWS Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include events outside of AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

Returns:

See Also:



72
73
74
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 72

def advanced_event_selectors
  @advanced_event_selectors
end

#billing_mode ⇒ String? (readonly)

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.

The following are the possible values:

  • EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.
  • FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.

The default value is EXTENDABLE_RETENTION_PRICING .

For more information about CloudTrail pricing, see AWS CloudTrail Pricing and Managing CloudTrail Lake costs .

Returns:

  • (String, nil)

See Also:



86
87
88
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 86

def billing_mode
  @billing_mode
end

#context_key_selectors ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



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

def context_key_selectors
  @context_key_selectors
end

#federation_enabled ⇒ Boolean, ... (readonly)

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:

See Also:



96
97
98
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 96

def federation_enabled
  @federation_enabled
end

#federation_role_arn ⇒ String? (readonly)

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

The federation role must exist in your account and provide the required minimum permissions .

Returns:

  • (String, nil)

See Also:



103
104
105
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 103

def federation_role_arn
  @federation_role_arn
end

#ingestion_enabled ⇒ Boolean, ... (readonly)

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

The default is true.

Returns:

See Also:



110
111
112
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 110

def ingestion_enabled
  @ingestion_enabled
end

#insight_selectors ⇒ AWSCDK::IResolvable, ... (readonly)

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

ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.

The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.

Returns:

See Also:



128
129
130
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 128

def insight_selectors
  @insight_selectors
end

#insights_destination ⇒ String? (readonly)

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

For more information, see Create an event data store for CloudTrail Insights events .

Returns:

  • (String, nil)

See Also:



117
118
119
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 117

def insights_destination
  @insights_destination
end

#kms_key_id ⇒ String? (readonly)

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

The value can be an alias name prefixed by alias/ , a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.

CloudTrail also supports AWS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide .

Examples:

  • alias/MyAliasName
  • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
  • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
  • 12345678-1234-1234-1234-123456789012

Returns:

  • (String, nil)

See Also:



146
147
148
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 146

def kms_key_id
  @kms_key_id
end

#max_event_size ⇒ String? (readonly)

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

If you are using context key selectors, MaxEventSize must be set to Large.

Returns:

  • (String, nil)

See Also:



153
154
155
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 153

def max_event_size
  @max_event_size
end

#multi_region_enabled ⇒ Boolean, ... (readonly)

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:

See Also:



158
159
160
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 158

def multi_region_enabled
  @multi_region_enabled
end

#name ⇒ String? (readonly)

The name of the event data store.

Returns:

  • (String, nil)

See Also:



163
164
165
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 163

def name
  @name
end

#organization_enabled ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



168
169
170
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 168

def organization_enabled
  @organization_enabled
end

#retention_period ⇒ Numeric? (readonly)

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

If BillingMode is set to EXTENDABLE_RETENTION_PRICING , you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING , you can set a retention period of up to 2557 days, the equivalent of seven years.

CloudTrail Lake determines whether to retain an event by checking if the event_time of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the event_time is older than 90 days.

If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.

Returns:

  • (Numeric, nil)

See Also:



179
180
181
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 179

def retention_period
  @retention_period
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of tags.

Returns:

See Also:



184
185
186
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 184

def tags
  @tags
end

#termination_protection_enabled ⇒ Boolean, ... (readonly)

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

If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.

Returns:

See Also:



191
192
193
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 191

def termination_protection_enabled
  @termination_protection_enabled
end

Class Method Details

.jsii_properties ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 193

def self.jsii_properties
  {
    :advanced_event_selectors => "advancedEventSelectors",
    :billing_mode => "billingMode",
    :context_key_selectors => "contextKeySelectors",
    :federation_enabled => "federationEnabled",
    :federation_role_arn => "federationRoleArn",
    :ingestion_enabled => "ingestionEnabled",
    :insights_destination => "insightsDestination",
    :insight_selectors => "insightSelectors",
    :kms_key_id => "kmsKeyId",
    :max_event_size => "maxEventSize",
    :multi_region_enabled => "multiRegionEnabled",
    :name => "name",
    :organization_enabled => "organizationEnabled",
    :retention_period => "retentionPeriod",
    :tags => "tags",
    :termination_protection_enabled => "terminationProtectionEnabled",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'cloud_trail/cfn_event_data_store_props.rb', line 214

def to_jsii
  result = {}
  result.merge!({
    "advancedEventSelectors" => @advanced_event_selectors,
    "billingMode" => @billing_mode,
    "contextKeySelectors" => @context_key_selectors,
    "federationEnabled" => @federation_enabled,
    "federationRoleArn" => @federation_role_arn,
    "ingestionEnabled" => @ingestion_enabled,
    "insightsDestination" => @insights_destination,
    "insightSelectors" => @insight_selectors,
    "kmsKeyId" => @kms_key_id,
    "maxEventSize" => @max_event_size,
    "multiRegionEnabled" => @multi_region_enabled,
    "name" => @name,
    "organizationEnabled" => @organization_enabled,
    "retentionPeriod" => @retention_period,
    "tags" => @tags,
    "terminationProtectionEnabled" => @termination_protection_enabled,
  })
  result.compact
end