CfnEventDataStore

class aws_cdk.aws_cloudtrail.CfnEventDataStore(scope, id, *, 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: CfnResource

A CloudFormation AWS::CloudTrail::EventDataStore.

Creates a new event data store.

CloudformationResource:: AWS::CloudTrail::EventDataStore
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 = cloudtrail.CfnEventDataStore(self, "MyCfnEventDataStore",
    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
)

Create a new AWS::CloudTrail::EventDataStore.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CloudTrail::EventDataStore'

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

attr_created_timestamp

Ref returns the time stamp of the creation of the event data store, such as 1248496624 .

CloudformationAttribute:: CreatedTimestamp

attr_event_data_store_arn

Ref returns the ARN of the CloudTrail event data store, such as arn:aws:cloudtrail:us-east-1:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE .

CloudformationAttribute:: EventDataStoreArn

attr_status

Ref returns the status of the event data store, such as ENABLED .

CloudformationAttribute:: Status

attr_updated_timestamp

Ref returns the time stamp that updates were made to an event data store, such as 1598296624 .

CloudformationAttribute:: UpdatedTimestamp

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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:

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

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

multi_region_enabled

Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

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

name

The name of the event data store.

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

node: The construct tree node associated with this construct.

organization_enabled

Specifies whether an event data store collects events logged for an organization in AWS Organizations .

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

retention_period

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.

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

A list of tags.

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

termination_protection_enabled

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#cfn-cloudtrail-eventdatastore-terminationprotectionenabled

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

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

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool

AdvancedEventSelectorProperty

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

Bases: object

Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record ﬁelds.

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

readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN

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

Parameters:

field_selectors (Union[IResolvable, Sequence[Union[IResolvable, AdvancedFieldSelectorProperty, Dict[str, Any]]]]) – 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”.

Link:

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.
import aws_cdk.aws_cloudtrail as cloudtrail

advanced_event_selector_property = 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"
)

Attributes

field_selectors

Contains all selector statements in an advanced event selector.

Link:: 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”.

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

AdvancedFieldSelectorProperty

class CfnEventDataStore.AdvancedFieldSelectorProperty(*, field, ends_with=None, equal_to=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:

field (str) – A field in a CloudTrail event record on which to filter events to be logged. For event data stores for AWS Config configuration items, Audit Manager evidence, or non- AWS events, the field is used only for selecting events as filtering is not supported. For CloudTrail event records, supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN . For event data stores for AWS Config configuration items, Audit Manager evidence, or non- AWS events, the only supported field is eventCategory . - ``readOnly`` - Optional. Can be set to Equals 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`` - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com . - ``eventName`` - Can use any operator. You can use it to ﬁlter in or ﬁlter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this ﬁeld, separated by commas. - ``eventCategory`` - This is required and must be set to Equals . - For CloudTrail event records, the value must be Management or Data . - For AWS Config configuration items, the value must be ConfigurationItem . - For Audit Manager evidence, the value must be Evidence . - For non- AWS events, the value must be ActivityAuditLog . - ``resources.type`` - This ﬁeld is required for CloudTrail data events. resources.type can only use the Equals operator, and the value can be one of the following: - AWS::DynamoDB::Table - AWS::Lambda::Function - AWS::S3::Object - AWS::CloudTrail::Channel - AWS::CodeWhisperer::Profile - AWS::Cognito::IdentityPool - AWS::DynamoDB::Stream - AWS::EC2::Snapshot - AWS::EMRWAL::Workspace - AWS::FinSpace::Environment - AWS::Glue::Table - AWS::GuardDuty::Detector - AWS::KendraRanking::ExecutionPlan - AWS::ManagedBlockchain::Node - AWS::SageMaker::ExperimentTrialComponent - AWS::SageMaker::FeatureGroup - AWS::S3::AccessPoint - AWS::S3ObjectLambda::AccessPoint - AWS::S3Outposts::Object - AWS::VerifiedPermissions::PolicyStore You can have only one resources.type ﬁeld per selector. To log data events on more than one resource type, add another selector. - ``resources.ARN`` - 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. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. 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. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information. - arn:<partition>:s3:::<bucket_name>/ - arn:<partition>:s3:::<bucket_name>/<object_path>/ When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name> When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:lambda:<region>:<account_ID>:function:<function_name> When resources.type equals AWS::CloudTrail::Channel , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID> When resources.type equals AWS::CodeWhisperer::Profile , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:codewhisperer:<region>:<account_ID>:profile/<profile_ID> When resources.type equals AWS::Cognito::IdentityPool , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_ID> When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time> When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:ec2:<region>::snapshot/<snapshot_ID> When resources.type equals AWS::EMRWAL::Workspace , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:emrwal:<region>::workspace/<workspace_name> When resources.type equals AWS::FinSpace::Environment , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID> When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name> When resources.type equals AWS::GuardDuty::Detector , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID> When resources.type equals AWS::KendraRanking::ExecutionPlan , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID> When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID> When resources.type equals AWS::SageMaker::ExperimentTrialComponent , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name> When resources.type equals AWS::SageMaker::FeatureGroup , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name> When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators. - arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name> - arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path> When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name> When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path> When resources.type equals AWS::VerifiedPermissions::PolicyStore , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>
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.
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 .

Link:

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.
import aws_cdk.aws_cloudtrail as cloudtrail

advanced_field_selector_property = 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"]
)

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 .

Link:: 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.

Link:: 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 AWS Config configuration items, Audit Manager evidence, or non- AWS events, the field is used only for selecting events as filtering is not supported.

For CloudTrail event records, supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

For event data stores for AWS Config configuration items, Audit Manager evidence, or non- AWS events, the only supported field is eventCategory .

``readOnly`` - Optional. Can be set to Equals 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`` - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .
``eventName`` - Can use any operator. You can use it to ﬁlter in or ﬁlter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this ﬁeld, separated by commas.
``eventCategory`` - This is required and must be set to Equals .
For CloudTrail event records, the value must be Management or Data .
For AWS Config configuration items, the value must be ConfigurationItem .
For Audit Manager evidence, the value must be Evidence .
For non- AWS events, the value must be ActivityAuditLog .
``resources.type`` - This ﬁeld is required for CloudTrail data events. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
AWS::CloudTrail::Channel
AWS::CodeWhisperer::Profile
AWS::Cognito::IdentityPool
AWS::DynamoDB::Stream
AWS::EC2::Snapshot
AWS::EMRWAL::Workspace
AWS::FinSpace::Environment
AWS::Glue::Table
AWS::GuardDuty::Detector
AWS::KendraRanking::ExecutionPlan
AWS::ManagedBlockchain::Node
AWS::SageMaker::ExperimentTrialComponent
AWS::SageMaker::FeatureGroup
AWS::S3::AccessPoint
AWS::S3ObjectLambda::AccessPoint
AWS::S3Outposts::Object
AWS::VerifiedPermissions::PolicyStore

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

``resources.ARN`` - 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. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. 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.

The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.

arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/

When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

When resources.type equals AWS::CloudTrail::Channel , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>

When resources.type equals AWS::CodeWhisperer::Profile , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:codewhisperer:<region>:<account_ID>:profile/<profile_ID>

When resources.type equals AWS::Cognito::IdentityPool , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_ID>

When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

When resources.type equals AWS::EMRWAL::Workspace , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:emrwal:<region>::workspace/<workspace_name>

When resources.type equals AWS::FinSpace::Environment , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>

When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>

When resources.type equals AWS::GuardDuty::Detector , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>

When resources.type equals AWS::KendraRanking::ExecutionPlan , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>

When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

When resources.type equals AWS::SageMaker::ExperimentTrialComponent , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>

When resources.type equals AWS::SageMaker::FeatureGroup , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>

When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

When resources.type equals AWS::VerifiedPermissions::PolicyStore , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>

Link:: 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 .

Link:: 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 .

Link:: 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 .

Link:: 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 .

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