Class: Aws::CloudTrail::Types::CreateEventDataStoreRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudTrail::Types::CreateEventDataStoreRequest
- Defined in:
- gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#advanced_event_selectors ⇒ Array<Types::AdvancedEventSelector>
The advanced event selectors to use to select the events for the data store.
-
#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.
-
#kms_key_id ⇒ String
Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail.
-
#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.
-
#name ⇒ String
The name of the event data store.
-
#organization_enabled ⇒ Boolean
Specifies whether an event data store collects events logged for an organization in Organizations.
-
#retention_period ⇒ Integer
The retention period of the event data store, in days.
-
#start_ingestion ⇒ Boolean
Specifies whether the event data store should start ingesting live events.
-
#tags_list ⇒ Array<Types::Tag>
A list of tags.
-
#termination_protection_enabled ⇒ Boolean
Specifies whether termination protection is enabled for the event data store.
Instance Attribute Details
#advanced_event_selectors ⇒ Array<Types::AdvancedEventSelector>
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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.
For more information about how to use advanced event selectors to include events outside of Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure 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.
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 CloudTrail Pricing and Managing CloudTrail Lake costs.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
Specifies the KMS 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 KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the 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
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure 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.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the event data store.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure end |
#organization_enabled ⇒ Boolean
Specifies whether an event data store collects events logged for an organization in Organizations.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure end |
#retention_period ⇒ Integer
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 eventTime
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 eventTime
is older than 90
days.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure end |
#start_ingestion ⇒ Boolean
Specifies whether the event data store should start ingesting live events. The default is true.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure end |
#tags_list ⇒ Array<Types::Tag>
A list of tags.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure end |
#termination_protection_enabled ⇒ Boolean
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.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1255 class CreateEventDataStoreRequest < Struct.new( :name, :advanced_event_selectors, :multi_region_enabled, :organization_enabled, :retention_period, :termination_protection_enabled, :tags_list, :kms_key_id, :start_ingestion, :billing_mode) SENSITIVE = [] include Aws::Structure end |