AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . cloudtrail ]
Configures event selectors (also referred to as basic event selectors ) or advanced event selectors for your trail. You can use either AdvancedEventSelectors
or EventSelectors
, but not both. If you apply AdvancedEventSelectors
to a trail, any existing EventSelectors
are overwritten.
You can use AdvancedEventSelectors
to log management events, data events for all resource types, and network activity events.
You can use EventSelectors
to log management events and data events for the following resource types:
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
You can't use EventSelectors
to log network activity events.
If you want your trail to log Insights events, be sure the event selector or advanced event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events in the CloudTrail User Guide . By default, trails created without specific event selectors are configured to log all read and write management events, and no data events or network activity events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in 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.
Example
GetConsoleOutput
and RunInstances
API operations occur in your account.RunInstances
is a write-only event and it matches your event selector. The trail logs the event.GetConsoleOutput
is a read-only event that doesn't match your event selector. The trail doesn't log the event.The PutEventSelectors
operation must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException
exception is thrown.
You can configure up to five event selectors for each trail.
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. For more information, see Logging management events , Logging data events , Logging network activity events , and Quotas in CloudTrail in the CloudTrail User Guide .
See also: AWS API Documentation
put-event-selectors
--trail-name <value>
[--event-selectors <value>]
[--advanced-event-selectors <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--trail-name
(string)
Specifies the name of the trail or trail ARN. If you specify a trail name, the string 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
andmy--namespace
are not valid.- Not be in IP address format (for example, 192.168.5.4)
If you specify a trail ARN, it must be in the following format.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
--event-selectors
(list)
Specifies the settings for your event selectors. You can use event selectors to log management events and data events for the following resource types:
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
You can't use event selectors to log network activity events.
You can configure up to five event selectors for a trail. You can use either
EventSelectors
orAdvancedEventSelectors
in aPutEventSelectors
request, but not both. If you applyEventSelectors
to a trail, any existingAdvancedEventSelectors
are overwritten.(structure)
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.
ReadWriteType -> (string)
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
.IncludeManagementEvents -> (boolean)
Specify if you want your event selector to include management events for your trail.
For more information, see Management Events in the 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 CloudTrail Pricing .
DataResources -> (list)
CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, 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 CloudTrail in the CloudTrail User Guide .
Note
To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also useAdvancedEventSelectors
if you want to filter on theeventName
field.(structure)
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.Note
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 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.Type -> (string)
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 -> (list)
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 Amazon Web Services account, specify the prefix as
arn:aws:s3
.Note
This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services 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 Amazon Web Services account, specify the prefix as
arn:aws:lambda
.Note
This also enables logging ofInvoke
activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.
- To log data events for a specific Lambda function, specify the function ARN.
Note
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 Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.(string)
ExcludeManagementEventSources -> (list)
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 Key Management Service or Amazon RDS Data API events by containing
kms.amazonaws.com
orrdsdata.amazonaws.com
. By default,ExcludeManagementEventSources
is empty, and 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.(string)
JSON Syntax:
[
{
"ReadWriteType": "ReadOnly"|"WriteOnly"|"All",
"IncludeManagementEvents": true|false,
"DataResources": [
{
"Type": "string",
"Values": ["string", ...]
}
...
],
"ExcludeManagementEventSources": ["string", ...]
}
...
]
--advanced-event-selectors
(list)
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 either
AdvancedEventSelectors
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 CloudTrail User Guide .(structure)
Advanced event selectors let you create fine-grained selectors for 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 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
Supported CloudTrail event record fields for network activity eventsNote
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
Note
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field iseventCategory
.Name -> (string)
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".FieldSelectors -> (list)
Contains all selector statements in an advanced event selector.
(structure)
A single selector statement in an advanced event selector.
Field -> (string)
A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
For CloudTrail management events, supported fields include
eventCategory
(required),eventSource
, andreadOnly
.For CloudTrail data events, supported fields include
eventCategory
(required),resources.type
(required),eventName
,readOnly
, andresources.ARN
.For CloudTrail network activity events, supported fields include
eventCategory
(required),eventSource
(required),eventName
,errorCode
, andvpcEndpointId
.For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, 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 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 and network activity events. For management events, 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 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 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 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 Config configuration items, the value must be
ConfigurationItem
.- For Audit Manager evidence, the value must be
Evidence
.- For non-Amazon Web Services events, the value must be
ActivityAuditLog
.
- **
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.- **
resources.type
** - This field is required for CloudTrail data events.resources.type
can only use theEquals
operator. The value can be one of the following:
AWS::AppConfig::Configuration
AWS::B2BI::Transformer
AWS::Bedrock::AgentAlias
AWS::Bedrock::FlowAlias
AWS::Bedrock::Guardrail
AWS::Bedrock::KnowledgeBase
AWS::Cassandra::Table
AWS::CloudFront::KeyValueStore
AWS::CloudTrail::Channel
AWS::CloudWatch::Metric
AWS::CodeWhisperer::Customization
AWS::CodeWhisperer::Profile
AWS::Cognito::IdentityPool
AWS::DynamoDB::Stream
AWS::DynamoDB::Table
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::Kinesis::Stream
AWS::Kinesis::StreamConsumer
AWS::KinesisVideo::Stream
AWS::Lambda::Function
AWS::MachineLearning::MlModel
AWS::ManagedBlockchain::Network
AWS::ManagedBlockchain::Node
AWS::MedicalImaging::Datastore
AWS::NeptuneGraph::Graph
AWS::One::UKey
AWS::One::User
AWS::PaymentCryptography::Alias
AWS::PaymentCryptography::Key
AWS::PCAConnectorAD::Connector
AWS::PCAConnectorSCEP::Connector
AWS::QApps:QApp
AWS::QBusiness::Application
AWS::QBusiness::DataSource
AWS::QBusiness::Index
AWS::QBusiness::WebExperience
AWS::RDS::DBCluster
AWS::RUM::AppMonitor
AWS::S3::AccessPoint
AWS::S3::Object
AWS::S3Express::Object
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::StepFunctions::StateMachine
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
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 CloudTrail User Guide .Note
You can't use theresources.ARN
field to filter resource types that do not have ARNs.
- **
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
.Equals -> (list)
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 thereadOnly
,eventCategory
, andresources.type
fields.(string)
StartsWith -> (list)
An operator that includes events that match the first few characters of the event record field specified as the value of
Field
.(string)
EndsWith -> (list)
An operator that includes events that match the last few characters of the event record field specified as the value of
Field
.(string)
NotEquals -> (list)
An operator that excludes events that match the exact value of the event record field specified as the value of
Field
.(string)
NotStartsWith -> (list)
An operator that excludes events that match the first few characters of the event record field specified as the value of
Field
.(string)
NotEndsWith -> (list)
An operator that excludes events that match the last few characters of the event record field specified as the value of
Field
.(string)
JSON Syntax:
[
{
"Name": "string",
"FieldSelectors": [
{
"Field": "string",
"Equals": ["string", ...],
"StartsWith": ["string", ...],
"EndsWith": ["string", ...],
"NotEquals": ["string", ...],
"NotStartsWith": ["string", ...],
"NotEndsWith": ["string", ...]
}
...
]
}
...
]
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: Configure a trail to log management events and data events by using 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 advanced event selectors to log all available data event types. You can use either advanced event selectors or basic event selectors, but not both. If you apply advanced event selectors to a trail, any existing basic event selectors are overwritten.
The following example creates an advanced event selector for a trail named myTrail
to log all management events, log S3 PutObject and DeleteObject API calls for all but one S3 bucket, log data API calls for a Lambda function named myFunction
, and log Publish API calls on an SNS topic named myTopic
.
aws cloudtrail put-event-selectors \
--trail-name myTrail \
--advanced-event-selectors '[{"Name": "Log all management events", "FieldSelectors": [{ "Field": "eventCategory", "Equals": ["Management"] }] },{"Name": "Log PutObject and DeleteObject events for all but one bucket","FieldSelectors": [{ "Field": "eventCategory", "Equals": ["Data"] },{ "Field": "resources.type", "Equals": ["AWS::S3::Object"] },{ "Field": "eventName", "Equals": ["PutObject","DeleteObject"] },{ "Field": "resources.ARN", "NotStartsWith": ["arn:aws:s3:::sample_bucket_name/"] }]},{"Name": "Log data events for a specific Lambda function","FieldSelectors": [{ "Field": "eventCategory", "Equals": ["Data"] },{ "Field": "resources.type", "Equals": ["AWS::Lambda::Function"] },{ "Field": "resources.ARN", "Equals": ["arn:aws:lambda:us-east-1:123456789012:function:myFunction"] }]},{"Name": "Log all Publish API calls on a specific SNS topic","FieldSelectors": [{ "Field": "eventCategory", "Equals": ["Data"] },{ "Field": "resources.type", "Equals": ["AWS::SNS::Topic"] },{ "Field": "eventName", "Equals": ["Publish"] },{ "Field": "resources.ARN", "Equals": ["arn:aws:sns:us-east-1:123456789012:myTopic.fifo"] }]}]'
Output:
{
"TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/myTrail",
"AdvancedEventSelectors": [
{
"Name": "Log all management events",
"FieldSelectors": [
{
"Field": "eventCategory",
"Equals": [
"Management"
]
}
]
},
{
"Name": "Log PutObject and DeleteObject events for all but one bucket",
"FieldSelectors": [
{
"Field": "eventCategory",
"Equals": [
"Data"
]
},
{
"Field": "resources.type",
"Equals": [
"AWS::S3::Object"
]
},
{
"Field": "eventName",
"Equals": [
"PutObject",
"DeleteObject"
]
},
{
"Field": "resources.ARN",
"NotStartsWith": [
"arn:aws:s3:::sample_bucket_name/"
]
}
]
},
{
"Name": "Log data events for a specific Lambda function",
"FieldSelectors": [
{
"Field": "eventCategory",
"Equals": [
"Data"
]
},
{
"Field": "resources.type",
"Equals": [
"AWS::Lambda::Function"
]
},
{
"Field": "resources.ARN",
"Equals": [
"arn:aws:lambda:us-east-1:123456789012:function:myFunction"
]
}
]
},
{
"Name": "Log all Publish API calls on a specific SNS topic",
"FieldSelectors": [
{
"Field": "eventCategory",
"Equals": [
"Data"
]
},
{
"Field": "resources.type",
"Equals": [
"AWS::SNS::Topic"
]
},
{
"Field": "eventName",
"Equals": [
"Publish"
]
},
{
"Field": "resources.ARN",
"Equals": [
"arn:aws:sns:us-east-1:123456789012:myTopic.fifo"
]
}
]
}
]
}
For more information, see Log events by using advanced event selectors in the AWS CloudTrail User Guide.
Example 2: Configure event selectors for a trail to log all management events and data events
You can configure up to 5 event selectors for a trail and up to 250 data resources for a trail. Event selectors are also referred to as basic event selectors. You can use event selectors to log management events and data events for S3 objects, Lambda functions, and DynnamoDB tables. To log data events for other resource types, you must use advanced event selectors.
The following example creates an event selector for a trail named TrailName
to include all management events, data events for two Amazon S3 bucket/prefix combinations, and data events for a single AWS Lambda function named hello-world-python-function
.
aws cloudtrail put-event-selectors \
--trail-name TrailName \
--event-selectors '[{"ReadWriteType": "All","IncludeManagementEvents": true,"DataResources": [{"Type":"AWS::S3::Object", "Values": ["arn:aws:s3:::mybucket/prefix","arn:aws:s3:::mybucket2/prefix2"]},{"Type": "AWS::Lambda::Function","Values": ["arn:aws:lambda:us-west-2:999999999999:function:hello-world-python-function"]}]}]'
Output:
{
"EventSelectors": [
{
"IncludeManagementEvents": true,
"DataResources": [
{
"Values": [
"arn:aws:s3:::mybucket/prefix",
"arn:aws:s3:::mybucket2/prefix2"
],
"Type": "AWS::S3::Object"
},
{
"Values": [
"arn:aws:lambda:us-west-2:123456789012:function:hello-world-python-function"
],
"Type": "AWS::Lambda::Function"
},
],
"ReadWriteType": "All"
}
],
"TrailARN": "arn:aws:cloudtrail:us-east-2:123456789012:trail/TrailName"
}
For more information, see Log events by using basic event selectors in the AWS CloudTrail User Guide.
Example 3: Configure event selectors for a trail to log management events, all S3 data events on S3 objects, and all Lambda data events on functions in your account
The following example creates an event selector for a trail named TrailName2
that includes all management events, and all data events for all Amazon S3 buckets and AWS Lambda functions in the AWS account.
aws cloudtrail put-event-selectors \
--trail-name TrailName2 \
--event-selectors '[{"ReadWriteType": "All","IncludeManagementEvents": true,"DataResources": [{"Type":"AWS::S3::Object", "Values": ["arn:aws:s3"]},{"Type": "AWS::Lambda::Function","Values": ["arn:aws:lambda"]}]}]'
Output:
{
"EventSelectors": [
{
"IncludeManagementEvents": true,
"DataResources": [
{
"Values": [
"arn:aws:s3"
],
"Type": "AWS::S3::Object"
},
{
"Values": [
"arn:aws:lambda"
],
"Type": "AWS::Lambda::Function"
},
],
"ReadWriteType": "All"
}
],
"TrailARN": "arn:aws:cloudtrail:us-east-2:123456789012:trail/TrailName2"
}
For more information, see Log events by using basic event selectors in the AWS CloudTrail User Guide.
TrailARN -> (string)
Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
EventSelectors -> (list)
Specifies the event selectors configured for your trail.
(structure)
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.
ReadWriteType -> (string)
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
.IncludeManagementEvents -> (boolean)
Specify if you want your event selector to include management events for your trail.
For more information, see Management Events in the 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 CloudTrail Pricing .
DataResources -> (list)
CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, 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 CloudTrail in the CloudTrail User Guide .
Note
To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also useAdvancedEventSelectors
if you want to filter on theeventName
field.(structure)
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.Note
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 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.Type -> (string)
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 -> (list)
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 Amazon Web Services account, specify the prefix as
arn:aws:s3
.Note
This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services 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 Amazon Web Services account, specify the prefix as
arn:aws:lambda
.Note
This also enables logging ofInvoke
activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.
- To log data events for a specific Lambda function, specify the function ARN.
Note
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 Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.(string)
ExcludeManagementEventSources -> (list)
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 Key Management Service or Amazon RDS Data API events by containing
kms.amazonaws.com
orrdsdata.amazonaws.com
. By default,ExcludeManagementEventSources
is empty, and 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.(string)
AdvancedEventSelectors -> (list)
Specifies the advanced event selectors configured for your trail.
(structure)
Advanced event selectors let you create fine-grained selectors for 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 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
Supported CloudTrail event record fields for network activity eventsNote
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
Note
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field iseventCategory
.Name -> (string)
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".FieldSelectors -> (list)
Contains all selector statements in an advanced event selector.
(structure)
A single selector statement in an advanced event selector.
Field -> (string)
A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
For CloudTrail management events, supported fields include
eventCategory
(required),eventSource
, andreadOnly
.For CloudTrail data events, supported fields include
eventCategory
(required),resources.type
(required),eventName
,readOnly
, andresources.ARN
.For CloudTrail network activity events, supported fields include
eventCategory
(required),eventSource
(required),eventName
,errorCode
, andvpcEndpointId
.For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, 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 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 and network activity events. For management events, 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 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 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 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 Config configuration items, the value must be
ConfigurationItem
.- For Audit Manager evidence, the value must be
Evidence
.- For non-Amazon Web Services events, the value must be
ActivityAuditLog
.
- **
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.- **
resources.type
** - This field is required for CloudTrail data events.resources.type
can only use theEquals
operator. The value can be one of the following:
AWS::AppConfig::Configuration
AWS::B2BI::Transformer
AWS::Bedrock::AgentAlias
AWS::Bedrock::FlowAlias
AWS::Bedrock::Guardrail
AWS::Bedrock::KnowledgeBase
AWS::Cassandra::Table
AWS::CloudFront::KeyValueStore
AWS::CloudTrail::Channel
AWS::CloudWatch::Metric
AWS::CodeWhisperer::Customization
AWS::CodeWhisperer::Profile
AWS::Cognito::IdentityPool
AWS::DynamoDB::Stream
AWS::DynamoDB::Table
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::Kinesis::Stream
AWS::Kinesis::StreamConsumer
AWS::KinesisVideo::Stream
AWS::Lambda::Function
AWS::MachineLearning::MlModel
AWS::ManagedBlockchain::Network
AWS::ManagedBlockchain::Node
AWS::MedicalImaging::Datastore
AWS::NeptuneGraph::Graph
AWS::One::UKey
AWS::One::User
AWS::PaymentCryptography::Alias
AWS::PaymentCryptography::Key
AWS::PCAConnectorAD::Connector
AWS::PCAConnectorSCEP::Connector
AWS::QApps:QApp
AWS::QBusiness::Application
AWS::QBusiness::DataSource
AWS::QBusiness::Index
AWS::QBusiness::WebExperience
AWS::RDS::DBCluster
AWS::RUM::AppMonitor
AWS::S3::AccessPoint
AWS::S3::Object
AWS::S3Express::Object
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::StepFunctions::StateMachine
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
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 CloudTrail User Guide .Note
You can't use theresources.ARN
field to filter resource types that do not have ARNs.
- **
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
.Equals -> (list)
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 thereadOnly
,eventCategory
, andresources.type
fields.(string)
StartsWith -> (list)
An operator that includes events that match the first few characters of the event record field specified as the value of
Field
.(string)
EndsWith -> (list)
An operator that includes events that match the last few characters of the event record field specified as the value of
Field
.(string)
NotEquals -> (list)
An operator that excludes events that match the exact value of the event record field specified as the value of
Field
.(string)
NotStartsWith -> (list)
An operator that excludes events that match the first few characters of the event record field specified as the value of
Field
.(string)
NotEndsWith -> (list)
An operator that excludes events that match the last few characters of the event record field specified as the value of
Field
.(string)