CfnEventDataStorePropsMixin

class aws_cdk.mixins_preview.aws_cloudtrail.mixins.CfnEventDataStorePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a new event data store.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html
CloudformationResource:: AWS::CloudTrail::EventDataStore
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_event_data_store_props_mixin = cloudtrail_mixins.CfnEventDataStorePropsMixin(cloudtrail_mixins.CfnEventDataStoreMixinProps(
    advanced_event_selectors=[cloudtrail_mixins.CfnEventDataStorePropsMixin.AdvancedEventSelectorProperty(
        field_selectors=[cloudtrail_mixins.CfnEventDataStorePropsMixin.AdvancedFieldSelectorProperty(
            ends_with=["endsWith"],
            equal_to=["equalTo"],
            field="field",
            not_ends_with=["notEndsWith"],
            not_equals=["notEquals"],
            not_starts_with=["notStartsWith"],
            starts_with=["startsWith"]
        )],
        name="name"
    )],
    billing_mode="billingMode",
    context_key_selectors=[cloudtrail_mixins.CfnEventDataStorePropsMixin.ContextKeySelectorProperty(
        equal_to=["equalTo"],
        type="type"
    )],
    federation_enabled=False,
    federation_role_arn="federationRoleArn",
    ingestion_enabled=False,
    insights_destination="insightsDestination",
    insight_selectors=[cloudtrail_mixins.CfnEventDataStorePropsMixin.InsightSelectorProperty(
        insight_type="insightType"
    )],
    kms_key_id="kmsKeyId",
    max_event_size="maxEventSize",
    multi_region_enabled=False,
    name="name",
    organization_enabled=False,
    retention_period=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    termination_protection_enabled=False
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CloudTrail::EventDataStore.

Parameters:

props (Union[CfnEventDataStoreMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['advancedEventSelectors', 'billingMode', 'contextKeySelectors', 'federationEnabled', 'federationRoleArn', 'ingestionEnabled', 'insightsDestination', 'insightSelectors', 'kmsKeyId', 'maxEventSize', 'multiRegionEnabled', 'name', 'organizationEnabled', 'retentionPeriod', 'tags', 'terminationProtectionEnabled']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AdvancedEventSelectorProperty

class CfnEventDataStorePropsMixin.AdvancedEventSelectorProperty(*, field_selectors=None, name=None)

Bases: object

Advanced event selectors let you create fine-grained selectors for AWS CloudTrail management, data, and network activity events.

They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events , Logging network activity events , and Logging management events topics in the AWS CloudTrail User Guide .

You cannot apply both event selectors and advanced event selectors to a trail.

Supported CloudTrail event record fields for management events

eventCategory (required)
eventSource
readOnly

The following additional fields are available for event data stores:

eventName
eventType
sessionCredentialFromConsole
userIdentity.arn

Supported CloudTrail event record fields for data events

eventCategory (required)
eventName
eventSource
eventType
resources.ARN
resources.type (required)
readOnly
sessionCredentialFromConsole
userIdentity.arn

Supported CloudTrail event record fields for network activity events

eventCategory (required)
eventSource (required)
eventName
errorCode - The only valid value for errorCode is VpceAccessDenied .
vpcEndpointId

For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is eventCategory .

Parameters:

field_selectors (Union[IResolvable, Sequence[Union[IResolvable, AdvancedFieldSelectorProperty, Dict[str, Any]]], None]) – Contains all selector statements in an advanced event selector.
name (Optional[str]) – An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

advanced_event_selector_property = cloudtrail_mixins.CfnEventDataStorePropsMixin.AdvancedEventSelectorProperty(
    field_selectors=[cloudtrail_mixins.CfnEventDataStorePropsMixin.AdvancedFieldSelectorProperty(
        ends_with=["endsWith"],
        equal_to=["equalTo"],
        field="field",
        not_ends_with=["notEndsWith"],
        not_equals=["notEquals"],
        not_starts_with=["notStartsWith"],
        starts_with=["startsWith"]
    )],
    name="name"
)

Attributes

field_selectors

Contains all selector statements in an advanced event selector.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html#cfn-cloudtrail-eventdatastore-advancedeventselector-fieldselectors

name

An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html#cfn-cloudtrail-eventdatastore-advancedeventselector-name

AdvancedFieldSelectorProperty

class CfnEventDataStorePropsMixin.AdvancedFieldSelectorProperty(*, ends_with=None, equal_to=None, field=None, not_ends_with=None, not_equals=None, not_starts_with=None, starts_with=None)

Bases: object

A single selector statement in an advanced event selector.

Parameters:

ends_with (Optional[Sequence[str]]) – An operator that includes events that match the last few characters of the event record field specified as the value of Field .
equal_to (Optional[Sequence[str]]) – An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.
field (Optional[str]) –
A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include eventCategory (required), eventSource , and readOnly . The following additional fields are available for event data stores: eventName , eventType , sessionCredentialFromConsole , and userIdentity.arn . For CloudTrail data events, supported fields include eventCategory (required), eventName , eventSource , eventType , resources.type (required), readOnly , resources.ARN , sessionCredentialFromConsole , and userIdentity.arn . For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName , errorCode , and vpcEndpointId . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is eventCategory . .. epigraph:: Selectors don’t support the use of wildcards like * . To match multiple values with a single condition, you may use StartsWith , EndsWith , NotStartsWith , or NotEndsWith to explicitly match the beginning or end of the event field. - ``readOnly`` - This is an optional field that is only used for management events and data events. This field can be set to Equals with a value of true or false . If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events. - ``eventSource`` - This field is only used for management events, data events, and network activity events. For management events for trails, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events. For data events for trails, this is an optional field that you can use to include or exclude any event source and can use any operator. For management and data events for event data stores, this is an optional field that you can use to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. For a list of services supporting network activity events, see Logging network activity events in the AWS CloudTrail User Guide . - ``eventName`` - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with eventName . You can use it to ﬁlter in or ﬁlter out specific events. You can have multiple values for this ﬁeld, separated by commas. - ``eventCategory`` - This field is required and must be set to Equals . - For CloudTrail management events, the value must be Management . - For CloudTrail data events, the value must be Data . - For CloudTrail network activity events, the value must be NetworkActivity . The following are used only for event data stores: - For CloudTrail Insights events, the value must be Insight . - For AWS Config configuration items, the value must be ConfigurationItem . - For Audit Manager evidence, the value must be Evidence . - For events outside of AWS , the value must be ActivityAuditLog . - ``eventType`` - For event data stores, this is an optional field available for event data stores to filter management and data events on the event type. For trails, this is an optional field to filter data events on the event type. For information about available event types, see CloudTrail record contents in the AWS CloudTrail user guide . - ``errorCode`` - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied . errorCode can only use the Equals operator. - ``sessionCredentialFromConsole`` - For event data stores, this is an optional field used to filter management and data events based on whether the events originated from an AWS Management Console session. For trails, this is an optional field used to filter data events. sessionCredentialFromConsole can only use the Equals and NotEquals operators. - ``resources.type`` - This ﬁeld is required for CloudTrail data events. resources.type can only use the Equals operator. For a list of available resource types for data events, see Data events in the AWS CloudTrail User Guide . You can have only one resources.type ﬁeld per selector. To log events on more than one resource type, add another selector. - ``resources.ARN`` - The resources.ARN is an optional field for data events. You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you’ve speciﬁed in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. For more information about the ARN formats of data event resources, see Actions, resources, and condition keys for AWS services in the Service Authorization Reference . .. epigraph:: You can’t use the resources.ARN field to filter resource types that do not have ARNs. - ``userIdentity.arn`` - For event data stores, this is an optional field used to filter management and data events for actions taken by specific IAM identities. For trails, this is an optional field used to filter data events. You can use any operator with userIdentity.arn . For more information on the userIdentity element, see CloudTrail userIdentity element in the AWS CloudTrail User Guide . - ``vpcEndpointId`` - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId .
not_ends_with (Optional[Sequence[str]]) – An operator that excludes events that match the last few characters of the event record field specified as the value of Field .
not_equals (Optional[Sequence[str]]) – An operator that excludes events that match the exact value of the event record field specified as the value of Field .
not_starts_with (Optional[Sequence[str]]) – An operator that excludes events that match the first few characters of the event record field specified as the value of Field .
starts_with (Optional[Sequence[str]]) – An operator that includes events that match the first few characters of the event record field specified as the value of Field .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

advanced_field_selector_property = cloudtrail_mixins.CfnEventDataStorePropsMixin.AdvancedFieldSelectorProperty(
    ends_with=["endsWith"],
    equal_to=["equalTo"],
    field="field",
    not_ends_with=["notEndsWith"],
    not_equals=["notEquals"],
    not_starts_with=["notStartsWith"],
    starts_with=["startsWith"]
)

Attributes

ends_with

An operator that includes events that match the last few characters of the event record field specified as the value of Field .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-endswith

equal_to

An operator that includes events that match the exact value of the event record field specified as the value of Field .

This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-equals

field

A field in a CloudTrail event record on which to filter events to be logged.

For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported.

For CloudTrail management events, supported fields include eventCategory (required), eventSource , and readOnly . The following additional fields are available for event data stores: eventName , eventType , sessionCredentialFromConsole , and userIdentity.arn .

For CloudTrail data events, supported fields include eventCategory (required), eventName , eventSource , eventType , resources.type (required), readOnly , resources.ARN , sessionCredentialFromConsole , and userIdentity.arn .

For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName , errorCode , and vpcEndpointId .

For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is eventCategory . .. epigraph:

Selectors don't support the use of wildcards like ``*`` . To match multiple values with a single condition, you may use ``StartsWith`` , ``EndsWith`` , ``NotStartsWith`` , or ``NotEndsWith`` to explicitly match the beginning or end of the event field.

``readOnly`` - This is an optional field that is only used for management events and data events. This field can be set to Equals with a value of true or false . If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events.
``eventSource`` - This field is only used for management events, data events, and network activity events.

For management events for trails, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events.

For data events for trails, this is an optional field that you can use to include or exclude any event source and can use any operator.

For management and data events for event data stores, this is an optional field that you can use to include or exclude any event source and can use any operator.

For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. For a list of services supporting network activity events, see Logging network activity events in the AWS CloudTrail User Guide .

``eventName`` - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with eventName . You can use it to ﬁlter in or ﬁlter out specific events. You can have multiple values for this ﬁeld, separated by commas.
``eventCategory`` - This field is required and must be set to Equals .
For CloudTrail management events, the value must be Management .
For CloudTrail data events, the value must be Data .
For CloudTrail network activity events, the value must be NetworkActivity .

The following are used only for event data stores:

For CloudTrail Insights events, the value must be Insight .
For AWS Config configuration items, the value must be ConfigurationItem .
For Audit Manager evidence, the value must be Evidence .
For events outside of AWS , the value must be ActivityAuditLog .
``eventType`` - For event data stores, this is an optional field available for event data stores to filter management and data events on the event type. For trails, this is an optional field to filter data events on the event type. For information about available event types, see CloudTrail record contents in the AWS CloudTrail user guide .
``errorCode`` - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied . errorCode can only use the Equals operator.
``sessionCredentialFromConsole`` - For event data stores, this is an optional field used to filter management and data events based on whether the events originated from an AWS Management Console session. For trails, this is an optional field used to filter data events. sessionCredentialFromConsole can only use the Equals and NotEquals operators.
``resources.type`` - This ﬁeld is required for CloudTrail data events. resources.type can only use the Equals operator.

For a list of available resource types for data events, see Data events in the AWS CloudTrail User Guide .

You can have only one resources.type ﬁeld per selector. To log events on more than one resource type, add another selector.

``resources.ARN`` - The resources.ARN is an optional field for data events. You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you’ve speciﬁed in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value.

For more information about the ARN formats of data event resources, see Actions, resources, and condition keys for AWS services in the Service Authorization Reference . .. epigraph:

You can't use the ``resources.ARN`` field to filter resource types that do not have ARNs.

``userIdentity.arn`` - For event data stores, this is an optional field used to filter management and data events for actions taken by specific IAM identities. For trails, this is an optional field used to filter data events. You can use any operator with userIdentity.arn . For more information on the userIdentity element, see CloudTrail userIdentity element in the AWS CloudTrail User Guide .
``vpcEndpointId`` - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-field

not_ends_with

An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notendswith

not_equals

An operator that excludes events that match the exact value of the event record field specified as the value of Field .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notequals

not_starts_with

An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notstartswith

starts_with

An operator that includes events that match the first few characters of the event record field specified as the value of Field .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-startswith

ContextKeySelectorProperty

class CfnEventDataStorePropsMixin.ContextKeySelectorProperty(*, equal_to=None, type=None)

Bases: object

An object that contains information types to be included in CloudTrail enriched events.

Parameters:

equal_to (Optional[Sequence[str]]) – A list of keys defined by Type to be included in CloudTrail enriched events.
type (Optional[str]) – Specifies the type of the event record field in ContextKeySelector. Valid values include RequestContext, TagContext.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

context_key_selector_property = cloudtrail_mixins.CfnEventDataStorePropsMixin.ContextKeySelectorProperty(
    equal_to=["equalTo"],
    type="type"
)

Attributes

equal_to

A list of keys defined by Type to be included in CloudTrail enriched events.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-contextkeyselector.html#cfn-cloudtrail-eventdatastore-contextkeyselector-equals

type

Specifies the type of the event record field in ContextKeySelector.

Valid values include RequestContext, TagContext.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-contextkeyselector.html#cfn-cloudtrail-eventdatastore-contextkeyselector-type

InsightSelectorProperty

class CfnEventDataStorePropsMixin.InsightSelectorProperty(*, insight_type=None)

Bases: object

A JSON string that contains a list of Insights types that are logged on an event data store.

Parameters:: insight_type (Optional[str]) – The type of Insights events 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.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-insightselector.html
ExampleMetadata:: fixture=_generated

Example:

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

insight_selector_property = cloudtrail_mixins.CfnEventDataStorePropsMixin.InsightSelectorProperty(
    insight_type="insightType"
)

Attributes

insight_type

The type of Insights events 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-insightselector.html#cfn-cloudtrail-eventdatastore-insightselector-insighttype