CfnEventDataStoreProps

class aws_cdk.aws_cloudtrail.CfnEventDataStoreProps(*, advanced_event_selectors=None, ingestion_enabled=None, kms_key_id=None, multi_region_enabled=None, name=None, organization_enabled=None, retention_period=None, tags=None, termination_protection_enabled=None)

Bases: object

Properties for defining a CfnEventDataStore.

Parameters:

advanced_event_selectors (Union[IResolvable, Sequence[Union[IResolvable, AdvancedEventSelectorProperty, Dict[str, Any]]], 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 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 non- AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.
ingestion_enabled (Union[bool, IResolvable, None]) – Specifies whether the event data store should start ingesting live events. The default is true.
kms_key_id (Optional[str]) – Specifies the AWS 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. .. epigraph:: 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 KMS 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
multi_region_enabled (Union[bool, IResolvable, 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.
name (Optional[str]) – The name of the event data store.
organization_enabled (Union[bool, IResolvable, None]) – Specifies whether an event data store collects events logged for an organization in AWS Organizations .
retention_period (Union[int, float, None]) – The retention period of the event data store, in days. You can set a retention period of up to 2557 days, the equivalent of seven years.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags.
termination_protection_enabled (Union[bool, IResolvable, 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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloudtrail as cloudtrail

cfn_event_data_store_props = cloudtrail.CfnEventDataStoreProps(
    advanced_event_selectors=[cloudtrail.CfnEventDataStore.AdvancedEventSelectorProperty(
        field_selectors=[cloudtrail.CfnEventDataStore.AdvancedFieldSelectorProperty(
            field="field",

            # the properties below are optional
            ends_with=["endsWith"],
            equal_to=["equalTo"],
            not_ends_with=["notEndsWith"],
            not_equals=["notEquals"],
            not_starts_with=["notStartsWith"],
            starts_with=["startsWith"]
        )],

        # the properties below are optional
        name="name"
    )],
    ingestion_enabled=False,
    kms_key_id="kmsKeyId",
    multi_region_enabled=False,
    name="name",
    organization_enabled=False,
    retention_period=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    termination_protection_enabled=False
)

Attributes

advanced_event_selectors

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 non- AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-advancedeventselectors

ingestion_enabled

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

The default is true.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-ingestionenabled

kms_key_id

Specifies the AWS 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. .. epigraph:

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 KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide .

Examples: