AWS::CloudTrail::Trail AdvancedFieldSelector
A single selector statement in an advanced event selector.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "EndsWith" :
[ String, ... ]
, "Equals" :[ String, ... ]
, "Field" :String
, "NotEndsWith" :[ String, ... ]
, "NotEquals" :[ String, ... ]
, "NotStartsWith" :[ String, ... ]
, "StartsWith" :[ String, ... ]
}
YAML
EndsWith:
- String
Equals:- String
Field:String
NotEndsWith:- String
NotEquals:- String
NotStartsWith:- String
StartsWith:- String
Properties
EndsWith
-
An operator that includes events that match the last few characters of the event record field specified as the value of
Field
.Required: No
Type: Array of String
Maximum:
2048
Minimum:
1 | 1
Update requires: No interruption
Equals
-
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.Required: No
Type: Array of String
Maximum:
2048
Minimum:
1 | 1
Update requires: No interruption
Field
-
A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Amazon Config configuration items, Audit Manager evidence, or events outside of Amazon, 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, Amazon Config configuration items, Audit Manager evidence, or events outside of Amazon, 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, 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 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 Amazon Config configuration items, the value must be
ConfigurationItem
. -
For Audit Manager evidence, the value must be
Evidence
. -
For events outside of Amazon, 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 Amazon 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 Amazon Web Services 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 Amazon 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
- 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 the
resources.ARN
field, see Filtering data events by resources.ARN in the Amazon CloudTrail User Guide.Note
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 withuserIdentity.arn
. For more information on the userIdentity element, see CloudTrail userIdentity element in the Amazon 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
.
Required: Yes
Type: String
Pattern:
([\w|\d|\.|_]+)
Minimum:
1
Maximum:
1000
Update requires: No interruption
-
NotEndsWith
-
An operator that excludes events that match the last few characters of the event record field specified as the value of
Field
.Required: No
Type: Array of String
Maximum:
2048
Minimum:
1 | 1
Update requires: No interruption
NotEquals
-
An operator that excludes events that match the exact value of the event record field specified as the value of
Field
.Required: No
Type: Array of String
Maximum:
2048
Minimum:
1 | 1
Update requires: No interruption
NotStartsWith
-
An operator that excludes events that match the first few characters of the event record field specified as the value of
Field
.Required: No
Type: Array of String
Maximum:
2048
Minimum:
1 | 1
Update requires: No interruption
StartsWith
-
An operator that includes events that match the first few characters of the event record field specified as the value of
Field
.Required: No
Type: Array of String
Maximum:
2048
Minimum:
1 | 1
Update requires: No interruption