software.amazon.awssdk.services.cloudtrail.model

Interface AdvancedFieldSelector.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>, SdkBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>, SdkPojo

Enclosing class:

AdvancedFieldSelector

public static interface AdvancedFieldSelector.Builder
extends SdkPojo, CopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>

Method Summary

Modifier and Type	Method and Description
AdvancedFieldSelector.Builder	endsWith(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.Builder	endsWith(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.Builder	equalsValue(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.Builder	equalsValue(String... equals) An operator that includes events that match the exact value of the event record field specified as the value of Field.
AdvancedFieldSelector.Builder	field(String field) A field in an event record on which to filter events to be logged.
AdvancedFieldSelector.Builder	notEndsWith(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.Builder	notEndsWith(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.Builder	notEquals(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.Builder	notEquals(String... notEquals) An operator that excludes events that match the exact value of the event record field specified as the value of Field.
AdvancedFieldSelector.Builder	notStartsWith(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.Builder	notStartsWith(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.Builder	startsWith(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.Builder	startsWith(String... startsWith) An operator that includes events that match the first few characters of the event record field specified as the value of Field.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

field

AdvancedFieldSelector.Builder field(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. 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 filter in or filter out any data event logged to CloudTrail, such as PutBucket. 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, or AWS::S3Outposts::Object. 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. 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

  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

Parameters:

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. 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 filter in or filter out any data event logged to CloudTrail, such as PutBucket. 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, or AWS::S3Outposts::Object. 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. 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

  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

Returns:

Returns a reference to this object so that method calls can be chained together.

equalsValue

AdvancedFieldSelector.Builder equalsValue(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

equalsValue

AdvancedFieldSelector.Builder equalsValue(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

startsWith

AdvancedFieldSelector.Builder startsWith(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.

Parameters:

startsWith - An operator that includes events that match the first few characters of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.

startsWith

AdvancedFieldSelector.Builder startsWith(String... startsWith)

An operator that includes events that match the first few characters of the event record field specified as the value of Field.

Parameters:

startsWith - An operator that includes events that match the first few characters of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.

endsWith

AdvancedFieldSelector.Builder endsWith(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.

Parameters:

endsWith - An operator that includes events that match the last few characters of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.

endsWith

AdvancedFieldSelector.Builder endsWith(String... endsWith)

An operator that includes events that match the last few characters of the event record field specified as the value of Field.

Parameters:

endsWith - An operator that includes events that match the last few characters of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.

notEquals

AdvancedFieldSelector.Builder notEquals(Collection<String> notEquals)

An operator that excludes events that match the exact value of the event record field specified as the value of Field.

Parameters:

notEquals - An operator that excludes events that match the exact value of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.

notEquals

AdvancedFieldSelector.Builder notEquals(String... notEquals)

An operator that excludes events that match the exact value of the event record field specified as the value of Field.

Parameters:

notEquals - An operator that excludes events that match the exact value of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.

notStartsWith

AdvancedFieldSelector.Builder notStartsWith(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.

Parameters:

notStartsWith - An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.

notStartsWith

AdvancedFieldSelector.Builder notStartsWith(String... notStartsWith)

An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

Parameters:

notStartsWith - An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.

notEndsWith

AdvancedFieldSelector.Builder notEndsWith(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.

Parameters:

notEndsWith - An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.

notEndsWith

AdvancedFieldSelector.Builder notEndsWith(String... notEndsWith)

An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

Parameters:

notEndsWith - An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

Returns:

Returns a reference to this object so that method calls can be chained together.