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 rules .advanced_event_selectors (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AdvancedEventSelectorProperty
,Dict
[str
,Any
]]],None
]) – Specifies the settings for advanced event selectors. You can use advanced event selectors to log management events, data events for all resource types, and network activity events. 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 eitherAdvancedEventSelectors
orEventSelectors
, but not both. If you applyAdvancedEventSelectors
to a trail, any existingEventSelectors
are overwritten. For more information about advanced event selectors, see Logging data events and Logging network activity 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. To enable CloudWatch Logs delivery, you must provide values forCloudWatchLogsLogGroupArn
andCloudWatchLogsRoleArn
. .. epigraph:: If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of theCloudWatchLogsRoleArn
andCloudWatchLogsLogGroupArn
fields to""
.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. To enable CloudWatch Logs delivery, you must provide values forCloudWatchLogsLogGroupArn
andCloudWatchLogsRoleArn
. .. epigraph:: If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of theCloudWatchLogsRoleArn
andCloudWatchLogsLogGroupArn
fields to""
.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
andApiErrorRateInsight
are valid Insight types. TheApiCallRateInsight
Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. TheApiErrorRateInsight
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 totrue
, 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 tofalse
, 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-123456789012s3_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 likemy-_namespace
andmy--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 prefixpath
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 toaddOverride
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: truedefault (
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:
- 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:
- 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 asarn: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 asarn: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 detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, 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 extendsConstruct
.
AdvancedEventSelectorProperty
- class CfnTrail.AdvancedEventSelectorProperty(*, field_selectors, name=None)
Bases:
object
Advanced event selectors let you create fine-grained selectors for AWS CloudTrail management, data, and network activity events.
They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events , Logging network activity events , and Logging management events topics in the AWS CloudTrail User Guide .
You cannot apply both event selectors and advanced event selectors to a trail.
Supported CloudTrail event record fields for management events
eventCategory
(required)eventSource
readOnly
The following additional fields are available for event data stores:
eventName
eventType
sessionCredentialFromConsole
userIdentity.arn
Supported CloudTrail event record fields for data events
eventCategory
(required)resources.type
(required)readOnly
eventName
resources.ARN
The following additional fields are available for event data stores:
eventSource
eventType
sessionCredentialFromConsole
userIdentity.arn
Supported CloudTrail event record fields for network activity events .. epigraph:
Network activity events is in preview release for CloudTrail and is subject to change.
eventCategory
(required)eventSource
(required)eventName
errorCode
- The only valid value forerrorCode
isVpceAccessDenied
.vpcEndpointId
For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is
eventCategory
.- Parameters:
field_selectors (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AdvancedFieldSelectorProperty
,Dict
[str
,Any
]]]]) – 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:
- 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.
- name
An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.
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 includeeventCategory
(required),eventSource
, andreadOnly
. The following additional fields are available for event data stores:eventName
,eventType
,sessionCredentialFromConsole
, anduserIdentity.arn
. For CloudTrail data events, supported fields includeeventCategory
(required),resources.type
(required),eventName
,readOnly
, andresources.ARN
. The following additional fields are available for event data stores:eventSource
,eventType
,sessionCredentialFromConsole
, anduserIdentity.arn
. For CloudTrail network activity events, supported fields includeeventCategory
(required),eventSource
(required),eventName
,errorCode
, andvpcEndpointId
. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field iseventCategory
. - ``readOnly`` - This is an optional field that is only used for management events and data events. This field can be set toEquals
with a value oftrue
orfalse
. If you do not add this field, CloudTrail logs bothread
andwrite
events. A value oftrue
logs onlyread
events. A value offalse
logs onlywrite
events. - ``eventSource`` - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set toNotEquals
kms.amazonaws.com
to exclude KMS management events, orNotEquals
rdsdata.amazonaws.com
to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses theEquals
operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events: -cloudtrail.amazonaws.com
-ec2.amazonaws.com
-kms.amazonaws.com
-secretsmanager.amazonaws.com
- ``eventName`` - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator witheventName
. You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas. - ``eventCategory`` - This field is required and must be set toEquals
. - For CloudTrail management events, the value must beManagement
. - For CloudTrail data events, the value must beData
. - For CloudTrail network activity events, the value must beNetworkActivity
. The following are used only for event data stores: - For CloudTrail Insights events, the value must beInsight
. - For AWS Config configuration items, the value must beConfigurationItem
. - For Audit Manager evidence, the value must beEvidence
. - For events outside of AWS , the value must beActivityAuditLog
. - ``eventType`` - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see CloudTrail record contents in the AWS CloudTrail user guide . - ``errorCode`` - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only validerrorCode
isVpceAccessDenied
.errorCode
can only use theEquals
operator. - ``sessionCredentialFromConsole`` - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session.sessionCredentialFromConsole
can only use theEquals
andNotEquals
operators. - ``resources.type`` - This field is required for CloudTrail data events.resources.type
can only use theEquals
operator. For a list of available resource types for data events, see Data events in the AWS CloudTrail User Guide . You can have only oneresources.type
field per selector. To log events on more than one resource type, add another selector. - ``resources.ARN`` - Theresources.ARN
is an optional field for data events. You can use any operator withresources.ARN
, but if you useEquals
orNotEquals
, the value must exactly match the ARN of a valid resource of the type you’ve specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use theStartsWith
operator, and include only the bucket ARN as the matching value. For information about filtering data events on theresources.ARN
field, see Filtering data events by resources.ARN in the AWS CloudTrail User Guide . .. epigraph:: You can’t use theresources.ARN
field to filter resource types that do not have ARNs. - ``userIdentity.arn`` - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator withuserIdentity.arn
. For more information on the userIdentity element, see CloudTrail userIdentity element in the AWS CloudTrail User Guide . - ``vpcEndpointId`` - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator withvpcEndpointId
.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 ofField
.equal_to (
Optional
[Sequence
[str
]]) – An operator that includes events that match the exact value of the event record field specified as the value ofField
. This is the only valid operator that you can use with thereadOnly
,eventCategory
, andresources.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 ofField
.not_equals (
Optional
[Sequence
[str
]]) – An operator that excludes events that match the exact value of the event record field specified as the value ofField
.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 ofField
.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 ofField
.
- See:
- 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
.
- 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
, andresources.type
fields.
- field
A field in a CloudTrail event record on which to filter events to be logged.
For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported.
For CloudTrail management events, supported fields include
eventCategory
(required),eventSource
, andreadOnly
. The following additional fields are available for event data stores:eventName
,eventType
,sessionCredentialFromConsole
, anduserIdentity.arn
.For CloudTrail data events, supported fields include
eventCategory
(required),resources.type
(required),eventName
,readOnly
, andresources.ARN
. The following additional fields are available for event data stores:eventSource
,eventType
,sessionCredentialFromConsole
, anduserIdentity.arn
.For CloudTrail network activity events, supported fields include
eventCategory
(required),eventSource
(required),eventName
,errorCode
, andvpcEndpointId
.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`` - This is an optional field that is only used for management events and data events. This field can be set to
Equals
with a value oftrue
orfalse
. If you do not add this field, CloudTrail logs bothread
andwrite
events. A value oftrue
logs onlyread
events. A value offalse
logs onlywrite
events.``eventSource`` - This field is only used for management events, data events (for event data stores only), and network activity events.
For management events for trails, this is an optional field that can be set to
NotEquals
kms.amazonaws.com
to exclude KMS management events, orNotEquals
rdsdata.amazonaws.com
to exclude RDS management events.For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator.
For network activity events, this is a required field that only uses the
Equals
operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source.The following are valid values for network activity events:
cloudtrail.amazonaws.com
ec2.amazonaws.com
kms.amazonaws.com
secretsmanager.amazonaws.com
``eventName`` - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with
eventName
. You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas.``eventCategory`` - This field is required and must be set to
Equals
.For CloudTrail management events, the value must be
Management
.For CloudTrail data events, the value must be
Data
.For CloudTrail network activity events, the value must be
NetworkActivity
.
The following are used only for event data stores:
For CloudTrail Insights events, the value must be
Insight
.For AWS Config configuration items, the value must be
ConfigurationItem
.For Audit Manager evidence, the value must be
Evidence
.For events outside of AWS , the value must be
ActivityAuditLog
.``eventType`` - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see CloudTrail record contents in the AWS CloudTrail user guide .
``errorCode`` - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid
errorCode
isVpceAccessDenied
.errorCode
can only use theEquals
operator.``sessionCredentialFromConsole`` - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session.
sessionCredentialFromConsole
can only use theEquals
andNotEquals
operators.``resources.type`` - This field is required for CloudTrail data events.
resources.type
can only use theEquals
operator.
For a list of available resource types for data events, see Data events in the AWS CloudTrail User Guide .
You can have only one
resources.type
field per selector. To log events on more than one resource type, add another selector.``resources.ARN`` - The
resources.ARN
is an optional field for data events. You can use any operator withresources.ARN
, but if you useEquals
orNotEquals
, the value must exactly match the ARN of a valid resource of the type you’ve specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use theStartsWith
operator, and include only the bucket ARN as the matching value.
For information about filtering data events on the
resources.ARN
field, see Filtering data events by resources.ARN in the AWS CloudTrail User Guide . .. epigraph:You can't use the ``resources.ARN`` field to filter resource types that do not have ARNs.
``userIdentity.arn`` - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with
userIdentity.arn
. For more information on the userIdentity element, see CloudTrail userIdentity element in the AWS CloudTrail User Guide .``vpcEndpointId`` - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with
vpcEndpointId
.
- not_ends_with
An operator that excludes events that match the last few characters of the event record field specified as the value of
Field
.
- not_equals
An operator that excludes events that match the exact value of the event record field specified as the value of
Field
.
- 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
.
- starts_with
An operator that includes events that match the first few characters of the event record field specified as the value of
Field
.
DataResourceProperty
- class CfnTrail.DataResourceProperty(*, type, values=None)
Bases:
object
You can configure the
DataResource
in anEventSelector
to log data events for the following three resource types:.AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use
AdvancedEventSelectors
if you want to filter on theeventName
field.Configure the
DataResource
to specify the resource type and resource ARNs for which you want to log data events. .. epigraph:The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.
The following example demonstrates how logging works when you configure logging of all data events for a general purpose bucket named
amzn-s3-demo-bucket1
. In this example, the CloudTrail user specified an empty prefix, and the option to log bothRead
andWrite
data events.A user uploads an image file to
amzn-s3-demo-bucket1
.The
PutObject
API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.A user uploads an object to an Amazon S3 bucket named
arn:aws:s3:::amzn-s3-demo-bucket1
.The
PutObject
API operation occurred for an object in an S3 bucket that the CloudTrail user didn’t specify for the trail. The trail doesn’t log the event.
The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named MyLambdaFunction , but not for all Lambda functions.
A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
The
Invoke
API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction , any invocations of that function are logged. The trail processes and logs the event.The
Invoke
API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, theInvoke
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, see AdvancedEventSelector .values (
Optional
[Sequence
[str
]]) – An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type. - To log data events for all objects in all S3 buckets in your AWS account , specify the prefix asarn: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 asarn:aws:s3:::amzn-s3-demo-bucket1/
. The trail logs data events for all objects in this S3 bucket. - To log data events for specific objects, specify the S3 bucket and object prefix such asarn:aws:s3:::amzn-s3-demo-bucket1/example-images
. The trail logs data events for objects in this S3 bucket that match the prefix. - To log data events for all Lambda functions in your AWS account , specify the prefix asarn:aws:lambda
. .. epigraph:: This also enables logging ofInvoke
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 asarn:aws:dynamodb
.
- See:
- 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, see AdvancedEventSelector .
- values
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.
To log data events for all objects in all S3 buckets in your AWS account , specify the prefix as
arn:aws:s3
.
This also enables logging of data event activity performed by any user or role in your AWS account , even if that activity is performed on a bucket that belongs to another AWS account .
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::amzn-s3-demo-bucket1/
. The trail logs data events for all objects in this S3 bucket.To log data events for specific objects, specify the S3 bucket and object prefix such as
arn:aws:s3:::amzn-s3-demo-bucket1/example-images
. The trail logs data events for objects in this S3 bucket that match the prefix.To log data events for all Lambda functions in your AWS account , specify the prefix as
arn:aws:lambda
.
This also enables logging of
Invoke
activity performed by any user or role in your AWS account , even if that activity is performed on a function that belongs to another AWS account .To log data events for a specific Lambda function, specify the function ARN.
Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld , data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld . They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2 .
To log data events for all DynamoDB tables in your AWS account , specify the prefix as
arn:aws:dynamodb
.
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 in standard S3 buckets, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events. For more information, see Data Events and Limits in AWS CloudTrail in the AWS CloudTrail User Guide . .. epigraph:: To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use
AdvancedEventSelectors
if you want to filter on theeventName
field.exclude_management_event_sources (
Optional
[Sequence
[str
]]) – An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service or Amazon RDS Data API events by containingkms.amazonaws.com
orrdsdata.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 istrue
. 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 EC2GetConsoleOutput
is a read-only API operation andRunInstances
is a write-only API operation. By default, the value isAll
.
- See:
- 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 in standard S3 buckets, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors.
You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.
For more information, see Data Events and Limits in AWS CloudTrail in the AWS CloudTrail User Guide . .. epigraph:
To log data events for all other resource types including objects stored in `directory buckets <https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html>`_ , you must use `AdvancedEventSelectors <https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html>`_ . You must also use ``AdvancedEventSelectors`` if you want to filter on the ``eventName`` field.
- 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
orrdsdata.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
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
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 andRunInstances
is a write-only API operation.By default, the value is
All
.
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
andApiErrorRateInsight
are valid Insight types. TheApiCallRateInsight
Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. TheApiErrorRateInsight
Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.- See:
- 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
andApiErrorRateInsight
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.