get-event-selectors¶

Description¶

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events.

For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide .

Synopsis¶

  get-event-selectors
--trail-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--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 and my--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 format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To view the event selector settings for a trail

The following get-event-selectors command returns the settings for Trail1:

aws cloudtrail get-event-selectors --trail-name Trail1

Output:

{
  "EventSelectors": [
      {
          "IncludeManagementEvents": true,
          "DataResources": [],
          "ReadWriteType": "All"
      }
  ],
  "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1"
}

Output¶

TrailARN -> (string)

The specified trail ARN that has the event selectors.

EventSelectors -> (list)

The event selectors that are configured for the 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 and RunInstances 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 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 .

DataResources -> (list)

CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. 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 .

(structure)

The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.

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.

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

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

A user uploads an image file to bucket-1 .

The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.

A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2 .

The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn’t specify for the trail. The trail doesn’t log the event.

The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named MyLambdaFunction , but not for all AWS 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 AWS 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 AWS Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.

Type -> (string)

The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.

Values -> (list)

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

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

Note

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

To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/ . The trail logs data events for all objects in this S3 bucket.

To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images . The trail logs data events for objects in this S3 bucket that match the prefix.

To log data events for all functions in your AWS account, specify the prefix as arn:aws:lambda .

Note

This will also enable 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.

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 .

(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 AWS Key Management Service events by containing "kms.amazonaws.com" . By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.

(string)

AdvancedEventSelectors -> (list)

The advanced event selectors that are configured for the trail.

(structure)

Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record ﬁelds. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the AWS CloudTrail User Guide .

readOnly

eventSource

eventName

eventCategory

resources.type

resources.ARN

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

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 an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

**readOnly ** - Optional. Can be set to Equals a value of true or false . A value of false logs both read and write events.

**eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .

**eventName ** - Can use any operator. You can use it to ﬁlter in or ﬁlter out any data event logged to CloudTrail, such as PutBucket . You can have multiple values for this ﬁeld, separated by commas.

**eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .

**resources.type ** - This ﬁeld is required. resources.type can only use the Equals operator, and the value can be one of the following: AWS::S3::Object or AWS::Lambda::Function . You can have only one resources.type ﬁeld per selector. To log data events on more than one resource type, add another selector.

**resources.ARN ** - You can use any operator with resources.ARN, but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you’ve speciﬁed in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. The trailing slash is intentional; do not exclude it.

arn:partition:s3:::bucket_name/

arn:partition:s3:::bucket_name/object_or_file_name/

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

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

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 the readOnly , eventCategory , and resources.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)

Table of Contents

Feedback

User Guide

get-event-selectors¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶