update_event_data_store¶
Operation¶
async
¶
update_event_data_store(input: UpdateEventDataStoreInput, plugins: list[Plugin] | None = None) -> UpdateEventDataStoreOutput
Updates an event data store. The required EventDataStore value is an
ARN or the ID portion of the ARN. Other parameters are optional, but at
least one optional parameter must be specified, or CloudTrail throws an
error. RetentionPeriod is in days, and valid values are integers
between 7 and 3653 if the BillingMode is set to
EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode
is set to FIXED_RETENTION_PRICING. By default, TerminationProtection
is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors
includes or excludes management, data, or network activity events in
your event data store. For more information about
AdvancedEventSelectors, see
AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config
configuration items, Audit Manager evidence, or non-Amazon Web Services
events, AdvancedEventSelectors includes events of that type in your
event data store.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateEventDataStoreInput
|
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 |
|---|---|
UpdateEventDataStoreOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateEventDataStoreInput structure.
Attributes¶
class-attribute
instance-attribute
¶
advanced_event_selectors: list[AdvancedEventSelector] | None = None
The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.
class-attribute
instance-attribute
¶
billing_mode: BillingMode | None = None
Note
You can't change the billing mode from EXTENDABLE_RETENTION_PRICING
to FIXED_RETENTION_PRICING. If BillingMode is set to
EXTENDABLE_RETENTION_PRICING and you want to use
FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the
event data store and create a new event data store that uses
FIXED_RETENTION_PRICING.
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.
For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.
class-attribute
instance-attribute
¶
event_data_store: str | None = None
The ARN (or the ID suffix of the ARN) of the event data store that you want to update.
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 an 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
Specifies whether an event data store collects events logged for an organization in Organizations.
Note
Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.
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 decrease the retention period of an event data store, CloudTrail
will remove any events with an eventTime older than the new retention
period. For example, if the previous retention period was 365 days and
you decrease it to 100 days, CloudTrail will remove events with an
eventTime older than 100 days.
Output¶
dataclass
¶
Dataclass for UpdateEventDataStoreOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
advanced_event_selectors: list[AdvancedEventSelector] | None = None
The advanced event selectors that are applied to the event 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 an event data store was first created.
class-attribute
instance-attribute
¶
event_data_store_arn: str | None = None
The ARN of the event data store.
class-attribute
instance-attribute
¶
federation_role_arn: str | None = None
If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.
class-attribute
instance-attribute
¶
federation_status: FederationStatus | None = None
Indicates the Lake query
federation
status. The status is ENABLED if Lake query federation is enabled, or
DISABLED if Lake query federation is disabled. You cannot delete an
event data store if the FederationStatus is ENABLED.
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 includes 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, in days.
class-attribute
instance-attribute
¶
status: EventDataStoreStatus | None = None
The status of an event data store.