CfnTrailPropsMixin

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

Bases: Mixin

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html
CloudformationResource:: AWS::CloudTrail::Trail
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_trail_props_mixin = cloudtrail_mixins.CfnTrailPropsMixin(cloudtrail_mixins.CfnTrailMixinProps(
    advanced_event_selectors=[cloudtrail_mixins.CfnTrailPropsMixin.AdvancedEventSelectorProperty(
        field_selectors=[cloudtrail_mixins.CfnTrailPropsMixin.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"
    )],
    aggregation_configurations=[cloudtrail_mixins.CfnTrailPropsMixin.AggregationConfigurationProperty(
        event_category="eventCategory",
        templates=["templates"]
    )],
    cloud_watch_logs_log_group_arn="cloudWatchLogsLogGroupArn",
    cloud_watch_logs_role_arn="cloudWatchLogsRoleArn",
    enable_log_file_validation=False,
    event_selectors=[cloudtrail_mixins.CfnTrailPropsMixin.EventSelectorProperty(
        data_resources=[cloudtrail_mixins.CfnTrailPropsMixin.DataResourceProperty(
            type="type",
            values=["values"]
        )],
        exclude_management_event_sources=["excludeManagementEventSources"],
        include_management_events=False,
        read_write_type="readWriteType"
    )],
    include_global_service_events=False,
    insight_selectors=[cloudtrail_mixins.CfnTrailPropsMixin.InsightSelectorProperty(
        event_categories=["eventCategories"],
        insight_type="insightType"
    )],
    is_logging=False,
    is_multi_region_trail=False,
    is_organization_trail=False,
    kms_key_id="kmsKeyId",
    s3_bucket_name="s3BucketName",
    s3_key_prefix="s3KeyPrefix",
    sns_topic_name="snsTopicName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    trail_name="trailName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnTrailMixinProps, 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', 'aggregationConfigurations', 'cloudWatchLogsLogGroupArn', 'cloudWatchLogsRoleArn', 'enableLogFileValidation', 'eventSelectors', 'includeGlobalServiceEvents', 'insightSelectors', 'isLogging', 'isMultiRegionTrail', 'isOrganizationTrail', 'kmsKeyId', 's3BucketName', 's3KeyPrefix', 'snsTopicName', 'tags', 'trailName']

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 CfnTrailPropsMixin.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-trail-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.CfnTrailPropsMixin.AdvancedEventSelectorProperty(
    field_selectors=[cloudtrail_mixins.CfnTrailPropsMixin.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-trail-advancedeventselector.html#cfn-cloudtrail-trail-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-trail-advancedeventselector.html#cfn-cloudtrail-trail-advancedeventselector-name

AdvancedFieldSelectorProperty

class CfnTrailPropsMixin.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-trail-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.CfnTrailPropsMixin.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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-advancedfieldselector-startswith

AggregationConfigurationProperty

class CfnTrailPropsMixin.AggregationConfigurationProperty(*, event_category=None, templates=None)

Bases: object

An object that contains configuration settings for aggregating events.

Parameters:

event_category (Optional[str]) – Specifies the event category for which aggregation should be performed.
templates (Optional[Sequence[str]]) – A list of aggregation templates that can be used to configure event aggregation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-aggregationconfiguration.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

aggregation_configuration_property = cloudtrail_mixins.CfnTrailPropsMixin.AggregationConfigurationProperty(
    event_category="eventCategory",
    templates=["templates"]
)

Attributes

event_category

Specifies the event category for which aggregation should be performed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-aggregationconfiguration.html#cfn-cloudtrail-trail-aggregationconfiguration-eventcategory

templates

A list of aggregation templates that can be used to configure event aggregation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-aggregationconfiguration.html#cfn-cloudtrail-trail-aggregationconfiguration-templates

DataResourceProperty

class CfnTrailPropsMixin.DataResourceProperty(*, type=None, values=None)

Bases: object

You can configure the DataResource in an EventSelector to log data events for the following three resource types:.

AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events. .. epigraph:

The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.

The following example demonstrates how logging works when you configure logging of all data events for a general purpose bucket named amzn-s3-demo-bucket1 . In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

A user uploads an image file to amzn-s3-demo-bucket1 .
The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::amzn-s3-demo-bucket1 .
The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn’t specify for the trail. The trail doesn’t log the event.

The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named MyLambdaFunction , but not for all Lambda functions.

A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction , any invocations of that function are logged. The trail processes and logs the event.
The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.

Parameters:

type (Optional[str]) – The resource type in which you want to log data events. You can specify the following basic event selector resource types: - AWS::DynamoDB::Table - AWS::Lambda::Function - AWS::S3::Object Additional resource types are available through advanced event selectors. For more information, see AdvancedEventSelector .
values (Optional[Sequence[str]]) – An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type. - To log data events for all objects in all S3 buckets in your AWS account , specify the prefix as arn:aws:s3 . .. epigraph:: This also enables logging of data event activity performed by any user or role in your AWS account , even if that activity is performed on a bucket that belongs to another AWS account . - To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/ . The trail logs data events for all objects in this S3 bucket. - To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/example-images . The trail logs data events for objects in this S3 bucket that match the prefix. - To log data events for all Lambda functions in your AWS account , specify the prefix as arn:aws:lambda . .. epigraph:: This also enables logging of Invoke activity performed by any user or role in your AWS account , even if that activity is performed on a function that belongs to another AWS account . - To log data events for a specific Lambda function, specify the function ARN. .. epigraph:: Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld , data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld . They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2 . - To log data events for all DynamoDB tables in your AWS account , specify the prefix as arn:aws:dynamodb .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.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

data_resource_property = cloudtrail_mixins.CfnTrailPropsMixin.DataResourceProperty(
    type="type",
    values=["values"]
)

Attributes

type

The resource type in which you want to log data events.

You can specify the following basic event selector resource types:

AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object

Additional resource types are available through advanced event selectors. For more information, see AdvancedEventSelector .

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

values

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.

To log data events for all objects in all S3 buckets in your AWS account , specify the prefix as arn:aws:s3 .

This also enables logging of data event activity performed by any user or role in your AWS account , even if that activity is performed on a bucket that belongs to another AWS account .

To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/ . The trail logs data events for all objects in this S3 bucket.
To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/example-images . The trail logs data events for objects in this S3 bucket that match the prefix.
To log data events for all Lambda functions in your AWS account , specify the prefix as arn:aws:lambda .

This also enables logging of Invoke activity performed by any user or role in your AWS account , even if that activity is performed on a function that belongs to another AWS account .

To log data events for a specific Lambda function, specify the function ARN.

Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld , data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld . They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2 .

To log data events for all DynamoDB tables in your AWS account , specify the prefix as arn:aws:dynamodb .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html#cfn-cloudtrail-trail-dataresource-values

EventSelectorProperty

class CfnTrailPropsMixin.EventSelectorProperty(*, data_resources=None, exclude_management_event_sources=None, include_management_events=None, read_write_type=None)

Bases: object

Use event selectors to further specify the management and data event settings for your trail.

By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn’t match any event selector, the trail doesn’t log the event.

You can configure up to five event selectors for a trail.

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

Parameters:

data_resources (Union[IResolvable, Sequence[Union[IResolvable, DataResourceProperty, Dict[str, Any]]], None]) –
CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events. For more information, see Data Events and Limits in AWS CloudTrail in the AWS CloudTrail User Guide . .. epigraph:: To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.
exclude_management_event_sources (Optional[Sequence[str]]) – An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com . By default, ExcludeManagementEventSources is empty, and AWS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.
include_management_events (Union[bool, IResolvable, None]) – Specify if you want your event selector to include management events for your trail. For more information, see Management Events in the AWS CloudTrail User Guide . By default, the value is true . The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see AWS CloudTrail Pricing .
read_write_type (Optional[str]) – Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation. By default, the value is All .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.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

event_selector_property = cloudtrail_mixins.CfnTrailPropsMixin.EventSelectorProperty(
    data_resources=[cloudtrail_mixins.CfnTrailPropsMixin.DataResourceProperty(
        type="type",
        values=["values"]
    )],
    exclude_management_event_sources=["excludeManagementEventSources"],
    include_management_events=False,
    read_write_type="readWriteType"
)

Attributes

data_resources

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors.

You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

For more information, see Data Events and Limits in AWS CloudTrail in the AWS CloudTrail User Guide . .. epigraph:

To log data events for all other resource types including objects stored in `directory buckets <https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html>`_ , you must use `AdvancedEventSelectors <https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html>`_ . You must also use ``AdvancedEventSelectors`` if you want to filter on the ``eventName`` field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-dataresources

exclude_management_event_sources

An optional list of service event sources from which you do not want management events to be logged on your trail.

In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com . By default, ExcludeManagementEventSources is empty, and AWS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-excludemanagementeventsources

include_management_events

Specify if you want your event selector to include management events for your trail.

For more information, see Management Events in the AWS CloudTrail User Guide .

By default, the value is true .

The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see AWS CloudTrail Pricing .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-includemanagementevents

read_write_type

Specify if you want your trail to log read-only events, write-only events, or all.

For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

By default, the value is All .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-readwritetype

InsightSelectorProperty

class CfnTrailPropsMixin.InsightSelectorProperty(*, event_categories=None, insight_type=None)

Bases: object

A JSON string that contains a list of Insights types that are logged on a trail.

Parameters:

event_categories (Optional[Sequence[str]]) – Select the event category on which Insights should be enabled. - If EventCategories is not provided, the specified Insights types are enabled on management API calls by default. - If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.
insight_type (Optional[str]) – The type of Insights events to log on a trail. 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-trail-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.CfnTrailPropsMixin.InsightSelectorProperty(
    event_categories=["eventCategories"],
    insight_type="insightType"
)

Attributes

event_categories

Select the event category on which Insights should be enabled.

If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.
If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

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

insight_type

The type of Insights events to log on a trail. 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-trail-insightselector.html#cfn-cloudtrail-trail-insightselector-insighttype