@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AdvancedFieldSelector extends Object implements Serializable, Cloneable, StructuredPojo
A single selector statement in an advanced event selector.
Constructor and Description |
---|
AdvancedFieldSelector() |
Modifier and Type | Method and Description |
---|---|
AdvancedFieldSelector |
clone() |
boolean |
equals(Object obj) |
List<String> |
getEndsWith()
An operator that includes events that match the last few characters of the event record field specified as the
value of
Field . |
List<String> |
getEquals()
An operator that includes events that match the exact value of the event record field specified as the value of
Field . |
String |
getField()
A field in an event record on which to filter events to be logged.
|
List<String> |
getNotEndsWith()
An operator that excludes events that match the last few characters of the event record field specified as the
value of
Field . |
List<String> |
getNotEquals()
An operator that excludes events that match the exact value of the event record field specified as the value of
Field . |
List<String> |
getNotStartsWith()
An operator that excludes events that match the first few characters of the event record field specified as the
value of
Field . |
List<String> |
getStartsWith()
An operator that includes events that match the first few characters of the event record field specified as the
value of
Field . |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setEndsWith(Collection<String> endsWith)
An operator that includes events that match the last few characters of the event record field specified as the
value of
Field . |
void |
setEquals(Collection<String> equals)
An operator that includes events that match the exact value of the event record field specified as the value of
Field . |
void |
setField(String field)
A field in an event record on which to filter events to be logged.
|
void |
setNotEndsWith(Collection<String> notEndsWith)
An operator that excludes events that match the last few characters of the event record field specified as the
value of
Field . |
void |
setNotEquals(Collection<String> notEquals)
An operator that excludes events that match the exact value of the event record field specified as the value of
Field . |
void |
setNotStartsWith(Collection<String> notStartsWith)
An operator that excludes events that match the first few characters of the event record field specified as the
value of
Field . |
void |
setStartsWith(Collection<String> startsWith)
An operator that includes events that match the first few characters of the event record field specified as the
value of
Field . |
String |
toString()
Returns a string representation of this object.
|
AdvancedFieldSelector |
withEndsWith(Collection<String> endsWith)
An operator that includes events that match the last few characters of the event record field specified as the
value of
Field . |
AdvancedFieldSelector |
withEndsWith(String... endsWith)
An operator that includes events that match the last few characters of the event record field specified as the
value of
Field . |
AdvancedFieldSelector |
withEquals(Collection<String> equals)
An operator that includes events that match the exact value of the event record field specified as the value of
Field . |
AdvancedFieldSelector |
withEquals(String... equals)
An operator that includes events that match the exact value of the event record field specified as the value of
Field . |
AdvancedFieldSelector |
withField(String field)
A field in an event record on which to filter events to be logged.
|
AdvancedFieldSelector |
withNotEndsWith(Collection<String> notEndsWith)
An operator that excludes events that match the last few characters of the event record field specified as the
value of
Field . |
AdvancedFieldSelector |
withNotEndsWith(String... notEndsWith)
An operator that excludes events that match the last few characters of the event record field specified as the
value of
Field . |
AdvancedFieldSelector |
withNotEquals(Collection<String> notEquals)
An operator that excludes events that match the exact value of the event record field specified as the value of
Field . |
AdvancedFieldSelector |
withNotEquals(String... notEquals)
An operator that excludes events that match the exact value of the event record field specified as the value of
Field . |
AdvancedFieldSelector |
withNotStartsWith(Collection<String> notStartsWith)
An operator that excludes events that match the first few characters of the event record field specified as the
value of
Field . |
AdvancedFieldSelector |
withNotStartsWith(String... notStartsWith)
An operator that excludes events that match the first few characters of the event record field specified as the
value of
Field . |
AdvancedFieldSelector |
withStartsWith(Collection<String> startsWith)
An operator that includes events that match the first few characters of the event record field specified as the
value of
Field . |
AdvancedFieldSelector |
withStartsWith(String... startsWith)
An operator that includes events that match the first few characters of the event record field specified as the
value of
Field . |
public void setField(String field)
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
. If you do not add this field, CloudTrail logs both both read
and
write
events. A value of true
logs only read
events. A value of
false
logs only write
events.
eventSource
- For filtering management events only. This can be set only to
NotEquals
kms.amazonaws.com
.
eventName
- Can use any operator. You can use it to filter in or filter out any data event
logged to CloudTrail, such as PutBucket
or GetSnapshotBlock
. You can have multiple
values for this field, separated by commas.
eventCategory
- This is required. It must be set to Equals
, and the value must
be Management
or Data
.
resources.type
- This field is required. resources.type
can only use the
Equals
operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
You can have only one resources.type
field 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 specified 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. To log all data events for all
objects in a specific S3 bucket, use the StartsWith
operator, and include only the bucket ARN as the
matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type
equals AWS::S3::AccessPoint
, and the operator is set to
Equals
or NotEquals
, the ARN must be in one of the following formats. To log events on
all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object
path, and use the StartsWith
or NotStartsWith
operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function
, and the operator is set to Equals
or
NotEquals
, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table
, and the operator is set to Equals
or
NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type
equals AWS::S3Outposts::Object
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type
equals AWS::ManagedBlockchain::Node
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type
equals AWS::S3ObjectLambda::AccessPoint
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type
equals AWS::EC2::Snapshot
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type
equals AWS::DynamoDB::Stream
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When resources.type
equals AWS::Glue::Table
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
field
- 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
. If you do not add this field, CloudTrail logs both both read
and
write
events. A value of true
logs only read
events. A value of
false
logs only write
events.
eventSource
- For filtering management events only. This can be set only to
NotEquals
kms.amazonaws.com
.
eventName
- Can use any operator. You can use it to filter in or filter out any data
event logged to CloudTrail, such as PutBucket
or GetSnapshotBlock
. You can have
multiple values for this field, separated by commas.
eventCategory
- This is required. It must be set to Equals
, and the
value must be Management
or Data
.
resources.type
- This field is required. resources.type
can only use the
Equals
operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
You can have only one resources.type
field 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 specified 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. To
log all data events for all objects in a specific S3 bucket, use the StartsWith
operator, and
include only the bucket ARN as the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type
equals AWS::S3::AccessPoint
, and the operator is set to
Equals
or NotEquals
, the ARN must be in one of the following formats. To log
events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t
include the object path, and use the StartsWith
or NotStartsWith
operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type
equals AWS::S3Outposts::Object
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type
equals AWS::ManagedBlockchain::Node
, and the operator is set
to Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type
equals AWS::S3ObjectLambda::AccessPoint
, and the operator is
set to Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type
equals AWS::EC2::Snapshot
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type
equals AWS::DynamoDB::Stream
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When resources.type
equals AWS::Glue::Table
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
public String getField()
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
. If you do not add this field, CloudTrail logs both both read
and
write
events. A value of true
logs only read
events. A value of
false
logs only write
events.
eventSource
- For filtering management events only. This can be set only to
NotEquals
kms.amazonaws.com
.
eventName
- Can use any operator. You can use it to filter in or filter out any data event
logged to CloudTrail, such as PutBucket
or GetSnapshotBlock
. You can have multiple
values for this field, separated by commas.
eventCategory
- This is required. It must be set to Equals
, and the value must
be Management
or Data
.
resources.type
- This field is required. resources.type
can only use the
Equals
operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
You can have only one resources.type
field 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 specified 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. To log all data events for all
objects in a specific S3 bucket, use the StartsWith
operator, and include only the bucket ARN as the
matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type
equals AWS::S3::AccessPoint
, and the operator is set to
Equals
or NotEquals
, the ARN must be in one of the following formats. To log events on
all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object
path, and use the StartsWith
or NotStartsWith
operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function
, and the operator is set to Equals
or
NotEquals
, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table
, and the operator is set to Equals
or
NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type
equals AWS::S3Outposts::Object
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type
equals AWS::ManagedBlockchain::Node
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type
equals AWS::S3ObjectLambda::AccessPoint
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type
equals AWS::EC2::Snapshot
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type
equals AWS::DynamoDB::Stream
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When resources.type
equals AWS::Glue::Table
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
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
. If you do not add this field, CloudTrail logs both both read
and
write
events. A value of true
logs only read
events. A value of
false
logs only write
events.
eventSource
- For filtering management events only. This can be set only to
NotEquals
kms.amazonaws.com
.
eventName
- Can use any operator. You can use it to filter in or filter out any data
event logged to CloudTrail, such as PutBucket
or GetSnapshotBlock
. You can have
multiple values for this field, separated by commas.
eventCategory
- This is required. It must be set to Equals
, and the
value must be Management
or Data
.
resources.type
- This field is required. resources.type
can only use
the Equals
operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
You can have only one resources.type
field 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 specified 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. To
log all data events for all objects in a specific S3 bucket, use the StartsWith
operator,
and include only the bucket ARN as the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type
equals AWS::S3::AccessPoint
, and the operator is set to
Equals
or NotEquals
, the ARN must be in one of the following formats. To log
events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t
include the object path, and use the StartsWith
or NotStartsWith
operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type
equals AWS::S3Outposts::Object
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type
equals AWS::ManagedBlockchain::Node
, and the operator is
set to Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type
equals AWS::S3ObjectLambda::AccessPoint
, and the operator
is set to Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type
equals AWS::EC2::Snapshot
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type
equals AWS::DynamoDB::Stream
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When resources.type
equals AWS::Glue::Table
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
public AdvancedFieldSelector withField(String field)
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
. If you do not add this field, CloudTrail logs both both read
and
write
events. A value of true
logs only read
events. A value of
false
logs only write
events.
eventSource
- For filtering management events only. This can be set only to
NotEquals
kms.amazonaws.com
.
eventName
- Can use any operator. You can use it to filter in or filter out any data event
logged to CloudTrail, such as PutBucket
or GetSnapshotBlock
. You can have multiple
values for this field, separated by commas.
eventCategory
- This is required. It must be set to Equals
, and the value must
be Management
or Data
.
resources.type
- This field is required. resources.type
can only use the
Equals
operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
You can have only one resources.type
field 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 specified 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. To log all data events for all
objects in a specific S3 bucket, use the StartsWith
operator, and include only the bucket ARN as the
matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type
equals AWS::S3::AccessPoint
, and the operator is set to
Equals
or NotEquals
, the ARN must be in one of the following formats. To log events on
all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object
path, and use the StartsWith
or NotStartsWith
operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function
, and the operator is set to Equals
or
NotEquals
, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table
, and the operator is set to Equals
or
NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type
equals AWS::S3Outposts::Object
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type
equals AWS::ManagedBlockchain::Node
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type
equals AWS::S3ObjectLambda::AccessPoint
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type
equals AWS::EC2::Snapshot
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type
equals AWS::DynamoDB::Stream
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When resources.type
equals AWS::Glue::Table
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
field
- 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
. If you do not add this field, CloudTrail logs both both read
and
write
events. A value of true
logs only read
events. A value of
false
logs only write
events.
eventSource
- For filtering management events only. This can be set only to
NotEquals
kms.amazonaws.com
.
eventName
- Can use any operator. You can use it to filter in or filter out any data
event logged to CloudTrail, such as PutBucket
or GetSnapshotBlock
. You can have
multiple values for this field, separated by commas.
eventCategory
- This is required. It must be set to Equals
, and the
value must be Management
or Data
.
resources.type
- This field is required. resources.type
can only use the
Equals
operator, and the value can be one of the following:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
You can have only one resources.type
field 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 specified 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. To
log all data events for all objects in a specific S3 bucket, use the StartsWith
operator, and
include only the bucket ARN as the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type
equals AWS::S3::AccessPoint
, and the operator is set to
Equals
or NotEquals
, the ARN must be in one of the following formats. To log
events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t
include the object path, and use the StartsWith
or NotStartsWith
operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type
equals AWS::S3Outposts::Object
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type
equals AWS::ManagedBlockchain::Node
, and the operator is set
to Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type
equals AWS::S3ObjectLambda::AccessPoint
, and the operator is
set to Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type
equals AWS::EC2::Snapshot
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type
equals AWS::DynamoDB::Stream
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When resources.type
equals AWS::Glue::Table
, and the operator is set to
Equals
or NotEquals
, the ARN must be in the following format:
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
public List<String> getEquals()
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.
Field
. This is the only valid operator that you can use with the
readOnly
, eventCategory
, and resources.type
fields.public void setEquals(Collection<String> 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 the readOnly
,
eventCategory
, and resources.type
fields.
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 the
readOnly
, eventCategory
, and resources.type
fields.public AdvancedFieldSelector withEquals(String... 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 the readOnly
,
eventCategory
, and resources.type
fields.
NOTE: This method appends the values to the existing list (if any). Use
setEquals(java.util.Collection)
or withEquals(java.util.Collection)
if you want to override the
existing values.
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 the
readOnly
, eventCategory
, and resources.type
fields.public AdvancedFieldSelector withEquals(Collection<String> 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 the readOnly
,
eventCategory
, and resources.type
fields.
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 the
readOnly
, eventCategory
, and resources.type
fields.public List<String> getStartsWith()
An operator that includes events that match the first few characters of the event record field specified as the
value of Field
.
Field
.public void setStartsWith(Collection<String> startsWith)
An operator that includes events that match the first few characters of the event record field specified as the
value of Field
.
startsWith
- An operator that includes events that match the first few characters of the event record field specified
as the value of Field
.public AdvancedFieldSelector withStartsWith(String... startsWith)
An operator that includes events that match the first few characters of the event record field specified as the
value of Field
.
NOTE: This method appends the values to the existing list (if any). Use
setStartsWith(java.util.Collection)
or withStartsWith(java.util.Collection)
if you want to
override the existing values.
startsWith
- An operator that includes events that match the first few characters of the event record field specified
as the value of Field
.public AdvancedFieldSelector withStartsWith(Collection<String> startsWith)
An operator that includes events that match the first few characters of the event record field specified as the
value of Field
.
startsWith
- An operator that includes events that match the first few characters of the event record field specified
as the value of Field
.public List<String> getEndsWith()
An operator that includes events that match the last few characters of the event record field specified as the
value of Field
.
Field
.public void setEndsWith(Collection<String> endsWith)
An operator that includes events that match the last few characters of the event record field specified as the
value of Field
.
endsWith
- An operator that includes events that match the last few characters of the event record field specified as
the value of Field
.public AdvancedFieldSelector withEndsWith(String... endsWith)
An operator that includes events that match the last few characters of the event record field specified as the
value of Field
.
NOTE: This method appends the values to the existing list (if any). Use
setEndsWith(java.util.Collection)
or withEndsWith(java.util.Collection)
if you want to override
the existing values.
endsWith
- An operator that includes events that match the last few characters of the event record field specified as
the value of Field
.public AdvancedFieldSelector withEndsWith(Collection<String> endsWith)
An operator that includes events that match the last few characters of the event record field specified as the
value of Field
.
endsWith
- An operator that includes events that match the last few characters of the event record field specified as
the value of Field
.public List<String> getNotEquals()
An operator that excludes events that match the exact value of the event record field specified as the value of
Field
.
Field
.public void setNotEquals(Collection<String> notEquals)
An operator that excludes events that match the exact value of the event record field specified as the value of
Field
.
notEquals
- An operator that excludes events that match the exact value of the event record field specified as the
value of Field
.public AdvancedFieldSelector withNotEquals(String... notEquals)
An operator that excludes events that match the exact value of the event record field specified as the value of
Field
.
NOTE: This method appends the values to the existing list (if any). Use
setNotEquals(java.util.Collection)
or withNotEquals(java.util.Collection)
if you want to
override the existing values.
notEquals
- An operator that excludes events that match the exact value of the event record field specified as the
value of Field
.public AdvancedFieldSelector withNotEquals(Collection<String> notEquals)
An operator that excludes events that match the exact value of the event record field specified as the value of
Field
.
notEquals
- An operator that excludes events that match the exact value of the event record field specified as the
value of Field
.public List<String> getNotStartsWith()
An operator that excludes events that match the first few characters of the event record field specified as the
value of Field
.
Field
.public void setNotStartsWith(Collection<String> notStartsWith)
An operator that excludes events that match the first few characters of the event record field specified as the
value of Field
.
notStartsWith
- An operator that excludes events that match the first few characters of the event record field specified
as the value of Field
.public AdvancedFieldSelector withNotStartsWith(String... notStartsWith)
An operator that excludes events that match the first few characters of the event record field specified as the
value of Field
.
NOTE: This method appends the values to the existing list (if any). Use
setNotStartsWith(java.util.Collection)
or withNotStartsWith(java.util.Collection)
if you want
to override the existing values.
notStartsWith
- An operator that excludes events that match the first few characters of the event record field specified
as the value of Field
.public AdvancedFieldSelector withNotStartsWith(Collection<String> notStartsWith)
An operator that excludes events that match the first few characters of the event record field specified as the
value of Field
.
notStartsWith
- An operator that excludes events that match the first few characters of the event record field specified
as the value of Field
.public List<String> getNotEndsWith()
An operator that excludes events that match the last few characters of the event record field specified as the
value of Field
.
Field
.public void setNotEndsWith(Collection<String> notEndsWith)
An operator that excludes events that match the last few characters of the event record field specified as the
value of Field
.
notEndsWith
- An operator that excludes events that match the last few characters of the event record field specified as
the value of Field
.public AdvancedFieldSelector withNotEndsWith(String... notEndsWith)
An operator that excludes events that match the last few characters of the event record field specified as the
value of Field
.
NOTE: This method appends the values to the existing list (if any). Use
setNotEndsWith(java.util.Collection)
or withNotEndsWith(java.util.Collection)
if you want to
override the existing values.
notEndsWith
- An operator that excludes events that match the last few characters of the event record field specified as
the value of Field
.public AdvancedFieldSelector withNotEndsWith(Collection<String> notEndsWith)
An operator that excludes events that match the last few characters of the event record field specified as the
value of Field
.
notEndsWith
- An operator that excludes events that match the last few characters of the event record field specified as
the value of Field
.public String toString()
toString
in class Object
Object.toString()
public AdvancedFieldSelector clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.