CfnTrail

class aws_cdk.aws_cloudtrail.CfnTrail(scope, id, *, is_logging, s3_bucket_name, advanced_event_selectors=None, cloud_watch_logs_log_group_arn=None, cloud_watch_logs_role_arn=None, enable_log_file_validation=None, event_selectors=None, include_global_service_events=None, insight_selectors=None, is_multi_region_trail=None, is_organization_trail=None, kms_key_id=None, s3_key_prefix=None, sns_topic_name=None, tags=None, trail_name=None)

Bases: CfnResource

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

cfn_trail = cloudtrail.CfnTrail(self, "MyCfnTrail",
    is_logging=False,
    s3_bucket_name="s3BucketName",

    # the properties below are optional
    advanced_event_selectors=[cloudtrail.CfnTrail.AdvancedEventSelectorProperty(
        field_selectors=[cloudtrail.CfnTrail.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"
    )],
    cloud_watch_logs_log_group_arn="cloudWatchLogsLogGroupArn",
    cloud_watch_logs_role_arn="cloudWatchLogsRoleArn",
    enable_log_file_validation=False,
    event_selectors=[cloudtrail.CfnTrail.EventSelectorProperty(
        data_resources=[cloudtrail.CfnTrail.DataResourceProperty(
            type="type",

            # the properties below are optional
            values=["values"]
        )],
        exclude_management_event_sources=["excludeManagementEventSources"],
        include_management_events=False,
        read_write_type="readWriteType"
    )],
    include_global_service_events=False,
    insight_selectors=[cloudtrail.CfnTrail.InsightSelectorProperty(
        insight_type="insightType"
    )],
    is_multi_region_trail=False,
    is_organization_trail=False,
    kms_key_id="kmsKeyId",
    s3_key_prefix="s3KeyPrefix",
    sns_topic_name="snsTopicName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    trail_name="trailName"
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
is_logging (Union[bool, IResolvable]) – Whether the CloudTrail trail is currently logging AWS API calls.
s3_bucket_name (str) – Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements .
advanced_event_selectors (Union[IResolvable, Sequence[Union[IResolvable, AdvancedEventSelectorProperty, Dict[str, Any]]], None]) – Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors , but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events in the AWS CloudTrail User Guide .
cloud_watch_logs_log_group_arn (Optional[str]) – Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account. Not required unless you specify CloudWatchLogsRoleArn .
cloud_watch_logs_role_arn (Optional[str]) – Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group. You must use a role that exists in your account.
enable_log_file_validation (Union[bool, IResolvable, None]) – Specifies whether log file validation is enabled. The default is false. .. epigraph:: When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
event_selectors (Union[IResolvable, Sequence[Union[IResolvable, EventSelectorProperty, Dict[str, Any]]], None]) – 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.
include_global_service_events (Union[bool, IResolvable, None]) – Specifies whether the trail is publishing events from global services such as IAM to the log files.
insight_selectors (Union[IResolvable, Sequence[Union[IResolvable, InsightSelectorProperty, Dict[str, Any]]], None]) – A JSON string that contains the Insights types you want 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.
is_multi_region_trail (Union[bool, IResolvable, None]) – Specifies whether the trail applies only to the current Region or to all Regions. The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions.
is_organization_trail (Union[bool, IResolvable, None]) – Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account . The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account for an organization in AWS Organizations . If the trail is not an organization trail and this is set to true , the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false , the trail will remain in the current AWS account but be deleted from all member accounts in the organization. .. epigraph:: Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail.
kms_key_id (Optional[str]) – Specifies the AWS KMS key ID to use to encrypt the logs 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. 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
s3_key_prefix (Optional[str]) – Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files . The maximum length is 200 characters.
sns_topic_name (Optional[str]) – Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A custom set of tags (key-value pairs) for this trail.
trail_name (Optional[str]) – Specifies the name of the trail. The name must meet the following requirements:. - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) - Start with a letter or number, and end with a letter or number - Be between 3 and 128 characters - Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid. - Not be in IP address format (for example, 192.168.5.4)

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

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 intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint]) –

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

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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::Trail'

advanced_event_selectors: Specifies the settings for advanced event selectors.

attr_arn

Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .

CloudformationAttribute:: Arn

attr_sns_topic_arn

Ref returns the ARN of the Amazon SNS topic that’s associated with the CloudTrail trail, such as arn:aws:sns:us-east-2:123456789012:mySNSTopic .

CloudformationAttribute:: SnsTopicArn

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

cfn_resource_type: AWS resource type.

cloud_watch_logs_log_group_arn: Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered.

cloud_watch_logs_role_arn: Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.

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.

enable_log_file_validation

Specifies whether log file validation is enabled.

The default is false.

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

include_global_service_events: Specifies whether the trail is publishing events from global services such as IAM to the log files.

insight_selectors: A JSON string that contains the Insights types you want to log on a trail.

is_logging: Whether the CloudTrail trail is currently logging AWS API calls.

is_multi_region_trail: Specifies whether the trail applies only to the current Region or to all Regions.

is_organization_trail: Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .

kms_key_id: Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail.

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.

node: The tree node.

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 }).

s3_bucket_name: Specifies the name of the Amazon S3 bucket designated for publishing log files.

s3_key_prefix: Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.

sns_topic_name: Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

stack

The stack in which this element is defined.

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

tags: Tag Manager which manages the tags for this resource.

tags_raw: A custom set of tags (key-value pairs) for this trail.

trail_name

Specifies the name of the trail.

The name must meet the following requirements:.

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

AdvancedEventSelectorProperty

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

Bases: object

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

They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging management events and Logging data events 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

Supported CloudTrail event record fields for data events

eventCategory (required)
resources.type (required)
readOnly
eventName
resources.ARN

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]]]]) – 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 import aws_cloudtrail as cloudtrail

advanced_event_selector_property = cloudtrail.CfnTrail.AdvancedEventSelectorProperty(
    field_selectors=[cloudtrail.CfnTrail.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.

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 CfnTrail.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 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 readOnly , eventCategory , and eventSource . For CloudTrail data events, supported fields include readOnly , eventCategory , eventName , resources.type , and resources.ARN . 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 . - ``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 to NotEquals kms.amazonaws.com or NotEquals rdsdata.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 management events, the value must be Management . - For CloudTrail data events, the value must be Data . 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 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::AppConfig::Configuration - AWS::B2BI::Transformer - AWS::Bedrock::AgentAlias - AWS::Bedrock::KnowledgeBase - AWS::Cassandra::Table - AWS::CloudFront::KeyValueStore - AWS::CloudTrail::Channel - AWS::CodeWhisperer::Customization - AWS::CodeWhisperer::Profile - AWS::Cognito::IdentityPool - AWS::DynamoDB::Stream - AWS::EC2::Snapshot - AWS::EMRWAL::Workspace - AWS::FinSpace::Environment - AWS::Glue::Table - AWS::GreengrassV2::ComponentVersion - AWS::GreengrassV2::Deployment - AWS::GuardDuty::Detector - AWS::IoT::Certificate - AWS::IoT::Thing - AWS::IoTSiteWise::Asset - AWS::IoTSiteWise::TimeSeries - AWS::IoTTwinMaker::Entity - AWS::IoTTwinMaker::Workspace - AWS::KendraRanking::ExecutionPlan - AWS::KinesisVideo::Stream - AWS::ManagedBlockchain::Network - AWS::ManagedBlockchain::Node - AWS::MedicalImaging::Datastore - AWS::NeptuneGraph::Graph - AWS::PCAConnectorAD::Connector - AWS::QBusiness::Application - AWS::QBusiness::DataSource - AWS::QBusiness::Index - AWS::QBusiness::WebExperience - AWS::RDS::DBCluster - AWS::S3::AccessPoint - AWS::S3ObjectLambda::AccessPoint - AWS::S3Outposts::Object - AWS::SageMaker::Endpoint - AWS::SageMaker::ExperimentTrialComponent - AWS::SageMaker::FeatureGroup - AWS::ServiceDiscovery::Namespace - AWS::ServiceDiscovery::Service - AWS::SCN::Instance - AWS::SNS::PlatformEndpoint - AWS::SNS::Topic - AWS::SQS::Queue - AWS::SSM::ManagedNode - AWS::SSMMessages::ControlChannel - AWS::SWF::Domain - AWS::ThinClient::Device - AWS::ThinClient::Environment - AWS::Timestream::Database - AWS::Timestream::Table - AWS::VerifiedPermissions::PolicyStore - AWS::XRay::Trace 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. .. epigraph:: You can’t use the resources.ARN field to filter resource types that do not have ARNs. The resources.ARN field can be set one of the following. 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::AppConfig::Configuration , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID> When resources.type equals AWS::B2BI::Transformer , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID> When resources.type equals AWS::Bedrock::AgentAlias , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID> When resources.type equals AWS::Bedrock::KnowledgeBase , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID> When resources.type equals AWS::Cassandra::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name> When resources.type equals AWS::CloudFront::KeyValueStore , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_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::Customization , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID> 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>:<account_ID>: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::GreengrassV2::ComponentVersion , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name> When resources.type equals AWS::GreengrassV2::Deployment , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID 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::IoT::Certificate , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID> When resources.type equals AWS::IoT::Thing , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID> When resources.type equals AWS::IoTSiteWise::Asset , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID> When resources.type equals AWS::IoTSiteWise::TimeSeries , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID> When resources.type equals AWS::IoTTwinMaker::Entity , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID> When resources.type equals AWS::IoTTwinMaker::Workspace , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_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::KinesisVideo::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time> When resources.type equals AWS::ManagedBlockchain::Network , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:managedblockchain:::networks/<network_name> 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::MedicalImaging::Datastore , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID> When resources.type equals AWS::NeptuneGraph::Graph , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID> When resources.type equals AWS::PCAConnectorAD::Connector , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID> When resources.type equals AWS::QBusiness::Application , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID> When resources.type equals AWS::QBusiness::DataSource , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID> When resources.type equals AWS::QBusiness::Index , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID> When resources.type equals AWS::QBusiness::WebExperience , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID> When resources.type equals AWS::RDS::DBCluster , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_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::SageMaker::Endpoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name> 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::SCN::Instance , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID> When resources.type equals AWS::ServiceDiscovery::Namespace , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID> When resources.type equals AWS::ServiceDiscovery::Service , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID> When resources.type equals AWS::SNS::PlatformEndpoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID> When resources.type equals AWS::SNS::Topic , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:sns:<region>:<account_ID>:<topic_name> When resources.type equals AWS::SQS::Queue , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:sqs:<region>:<account_ID>:<queue_name> When resources.type equals AWS::SSM::ManagedNode , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats: - arn:<partition>:ssm:<region>:<account_ID>:managed-instance/<instance_ID> - arn:<partition>:ec2:<region>:<account_ID>:instance/<instance_ID> When resources.type equals AWS::SSMMessages::ControlChannel , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID> When resources.type equals AWS::SWF::Domain , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name> When resources.type equals AWS::ThinClient::Device , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID> When resources.type equals AWS::ThinClient::Environment , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:thinclient:<region>:<account_ID>:environment/<environment_ID> When resources.type equals AWS::Timestream::Database , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:timestream:<region>:<account_ID>:database/<database_name> When resources.type equals AWS::Timestream::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format: - arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name> 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 .

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

advanced_field_selector_property = cloudtrail.CfnTrail.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 .

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 readOnly , eventCategory , and eventSource .

For CloudTrail data events, supported fields include readOnly , eventCategory , eventName , resources.type , and resources.ARN .

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 .

``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 to NotEquals kms.amazonaws.com or NotEquals rdsdata.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 management events, the value must be Management .
For CloudTrail data events, the value must be Data .

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 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::AppConfig::Configuration
AWS::B2BI::Transformer
AWS::Bedrock::AgentAlias
AWS::Bedrock::KnowledgeBase
AWS::Cassandra::Table
AWS::CloudFront::KeyValueStore
AWS::CloudTrail::Channel
AWS::CodeWhisperer::Customization
AWS::CodeWhisperer::Profile
AWS::Cognito::IdentityPool
AWS::DynamoDB::Stream
AWS::EC2::Snapshot
AWS::EMRWAL::Workspace
AWS::FinSpace::Environment
AWS::Glue::Table
AWS::GreengrassV2::ComponentVersion
AWS::GreengrassV2::Deployment
AWS::GuardDuty::Detector
AWS::IoT::Certificate
AWS::IoT::Thing
AWS::IoTSiteWise::Asset
AWS::IoTSiteWise::TimeSeries
AWS::IoTTwinMaker::Entity
AWS::IoTTwinMaker::Workspace
AWS::KendraRanking::ExecutionPlan
AWS::KinesisVideo::Stream
AWS::ManagedBlockchain::Network
AWS::ManagedBlockchain::Node
AWS::MedicalImaging::Datastore
AWS::NeptuneGraph::Graph
AWS::PCAConnectorAD::Connector
AWS::QBusiness::Application
AWS::QBusiness::DataSource
AWS::QBusiness::Index
AWS::QBusiness::WebExperience
AWS::RDS::DBCluster
AWS::S3::AccessPoint
AWS::S3ObjectLambda::AccessPoint
AWS::S3Outposts::Object
AWS::SageMaker::Endpoint
AWS::SageMaker::ExperimentTrialComponent
AWS::SageMaker::FeatureGroup
AWS::ServiceDiscovery::Namespace
AWS::ServiceDiscovery::Service
AWS::SCN::Instance
AWS::SNS::PlatformEndpoint
AWS::SNS::Topic
AWS::SQS::Queue
AWS::SSM::ManagedNode
AWS::SSMMessages::ControlChannel
AWS::SWF::Domain
AWS::ThinClient::Device
AWS::ThinClient::Environment
AWS::Timestream::Database
AWS::Timestream::Table
AWS::VerifiedPermissions::PolicyStore
AWS::XRay::Trace

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.

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

The resources.ARN field can be set one of the following.

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::AppConfig::Configuration , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>

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

arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>

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

arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>

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

arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>

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

arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>

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

arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_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::Customization , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>

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>:<account_ID>: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::GreengrassV2::ComponentVersion , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>

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

arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID

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::IoT::Certificate , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>

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

arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>

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

arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>

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

arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>

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

arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>

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

arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_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::KinesisVideo::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>

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

arn:<partition>:managedblockchain:::networks/<network_name>

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::MedicalImaging::Datastore , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>

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

arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>

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

arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>

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

arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>

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

arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>

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

arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>

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

arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>

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

arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_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::SageMaker::Endpoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>

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::SCN::Instance , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>

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

arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>

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

arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>

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

arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>

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

arn:<partition>:sns:<region>:<account_ID>:<topic_name>

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

arn:<partition>:sqs:<region>:<account_ID>:<queue_name>

When resources.type equals AWS::SSM::ManagedNode , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats:

arn:<partition>:ssm:<region>:<account_ID>:managed-instance/<instance_ID>
arn:<partition>:ec2:<region>:<account_ID>:instance/<instance_ID>

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

arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>

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

arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>

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

arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>

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

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

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

arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>

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

arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>

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>

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

DataResourceProperty

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

Bases: object

The Amazon S3 buckets, AWS Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events.

Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail. .. 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.

If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.

The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1 . 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 bucket-1 .
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:::bucket-2 .
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 (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 about these additional resource types, see AdvancedFieldSelector .
values (Optional[Sequence[str]]) – An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects. - 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:::bucket-1/ . 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:::bucket-1/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 import aws_cloudtrail as cloudtrail

data_resource_property = cloudtrail.CfnTrail.DataResourceProperty(
    type="type",

    # the properties below are optional
    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 about these additional resource types, see AdvancedFieldSelector .

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 objects.

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:::bucket-1/ . 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:::bucket-1/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 CfnTrail.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, 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 .
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 KMS 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 import aws_cloudtrail as cloudtrail

event_selector_property = cloudtrail.CfnTrail.EventSelectorProperty(
    data_resources=[cloudtrail.CfnTrail.DataResourceProperty(
        type="type",

        # the properties below are optional
        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, 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 .

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 KMS 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 CfnTrail.InsightSelectorProperty(*, insight_type=None)

Bases: object

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

Parameters:: 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 import aws_cloudtrail as cloudtrail

insight_selector_property = cloudtrail.CfnTrail.InsightSelectorProperty(
    insight_type="insightType"
)

Attributes

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