com.amazonaws.services.cloudtrail.model

Class AdvancedFieldSelector

java.lang.Object

com.amazonaws.services.cloudtrail.model.AdvancedFieldSelector

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdvancedFieldSelector()

Method Summary

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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdvancedFieldSelector

public AdvancedFieldSelector()

Method Detail

setField

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. 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

getField

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. 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:

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

withField

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. 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.

getEquals

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.

Returns:

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.

setEquals

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.

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.

withEquals

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.

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.

withEquals

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.

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.

getStartsWith

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.

Returns:

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

setStartsWith

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.

Parameters:

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

withStartsWith

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.

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.

withStartsWith

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.

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.

getEndsWith

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.

Returns:

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

setEndsWith

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.

Parameters:

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

withEndsWith

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.

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.

withEndsWith

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.

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.

getNotEquals

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.

Returns:

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

setNotEquals

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.

Parameters:

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

withNotEquals

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.

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.

withNotEquals

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.

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.

getNotStartsWith

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.

Returns:

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

setNotStartsWith

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.

Parameters:

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

withNotStartsWith

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.

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.

withNotStartsWith

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.

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.

getNotEndsWith

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.

Returns:

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

setNotEndsWith

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.

Parameters:

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

withNotEndsWith

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.

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.

withNotEndsWith

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.

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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AdvancedFieldSelector clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.