create_event_data_store¶
Operation¶
async
¶
create_event_data_store(input: CreateEventDataStoreInput, plugins: list[Plugin] | None = None) -> CreateEventDataStoreOutput
Creates a new event data store.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateEventDataStoreInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateEventDataStoreOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateEventDataStoreInput structure.
Attributes¶
class-attribute
instance-attribute
¶
advanced_event_selectors: list[AdvancedEventSelector] | None = None
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.
class-attribute
instance-attribute
¶
billing_mode: BillingMode | None = None
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.
class-attribute
instance-attribute
¶
kms_key_id: str | None = None
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.
Warning
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
class-attribute
instance-attribute
¶
multi_region_enabled: bool | None = None
Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.
class-attribute
instance-attribute
¶
organization_enabled: bool | None = None
Specifies whether an event data store collects events logged for an organization in Organizations.
class-attribute
instance-attribute
¶
retention_period: int | None = None
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.
Note
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.
class-attribute
instance-attribute
¶
start_ingestion: bool | None = None
Specifies whether the event data store should start ingesting live events. The default is true.
class-attribute
instance-attribute
¶
termination_protection_enabled: bool | None = None
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.
Output¶
dataclass
¶
Dataclass for CreateEventDataStoreOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
advanced_event_selectors: list[AdvancedEventSelector] | None = None
The advanced event selectors that were used to select the events for the data store.
class-attribute
instance-attribute
¶
billing_mode: BillingMode | None = None
The billing mode for the event data store.
class-attribute
instance-attribute
¶
created_timestamp: datetime | None = None
The timestamp that shows when the event data store was created.
class-attribute
instance-attribute
¶
event_data_store_arn: str | None = None
The ARN of the event data store.
class-attribute
instance-attribute
¶
kms_key_id: str | None = None
Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
class-attribute
instance-attribute
¶
multi_region_enabled: bool | None = None
Indicates whether the event data store collects events from all Regions, or only from the Region in which it was created.
class-attribute
instance-attribute
¶
organization_enabled: bool | None = None
Indicates whether an event data store is collecting logged events for an organization in Organizations.
class-attribute
instance-attribute
¶
retention_period: int | None = None
The retention period of an event data store, in days.
class-attribute
instance-attribute
¶
status: EventDataStoreStatus | None = None
The status of event data store creation.