software.amazon.awssdk.services.cloudtrail.model

Class AdvancedFieldSelector

java.lang.Object

software.amazon.awssdk.services.cloudtrail.model.AdvancedFieldSelector

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>

@Generated(value="software.amazon.awssdk:codegen")
public final class AdvancedFieldSelector
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>

A single selector statement in an advanced event selector.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdvancedFieldSelector.Builder

Method Summary

Modifier and Type	Method and Description
static AdvancedFieldSelector.Builder	builder()
List<String>	endsWith() An operator that includes events that match the last few characters of the event record field specified as the value of Field.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	equalsValue() An operator that includes events that match the exact value of the event record field specified as the value of Field.
String	field() A field in a CloudTrail event record on which to filter events to be logged.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEndsWith() For responses, this returns true if the service returned a value for the EndsWith property.
boolean	hasEqualsValue() For responses, this returns true if the service returned a value for the Equals property.
int	hashCode()
boolean	hasNotEndsWith() For responses, this returns true if the service returned a value for the NotEndsWith property.
boolean	hasNotEquals() For responses, this returns true if the service returned a value for the NotEquals property.
boolean	hasNotStartsWith() For responses, this returns true if the service returned a value for the NotStartsWith property.
boolean	hasStartsWith() For responses, this returns true if the service returned a value for the StartsWith property.
List<String>	notEndsWith() An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
List<String>	notEquals() An operator that excludes events that match the exact value of the event record field specified as the value of Field.
List<String>	notStartsWith() An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
List<SdkField<?>>	sdkFields()
static Class<? extends AdvancedFieldSelector.Builder>	serializableBuilderClass()
List<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	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

field

public final String field()

A field in a CloudTrail event record on which to filter events to be logged. For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.

For CloudTrail event records, supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is eventCategory.

• readOnly - Optional. Can be set to Equals a value of true or false. If you do not add this field, CloudTrail logs 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 and must be set to Equals.

  • For CloudTrail event records, the value must be Management or Data.

  • For Config configuration items, the value must be ConfigurationItem.

  • For Audit Manager evidence, the value must be Evidence.

  • For non-Amazon Web Services events, the value must be ActivityAuditLog.

• resources.type - This field is required for CloudTrail data events. resources.type can only use the Equals operator, and the value can be one of the following:

  • AWS::DynamoDB::Table

  • AWS::Lambda::Function

  • AWS::S3::Object

  • AWS::CloudTrail::Channel

  • AWS::CodeWhisperer::Profile

  • AWS::Cognito::IdentityPool

  • AWS::DynamoDB::Stream

  • AWS::EC2::Snapshot

  • AWS::EMRWAL::Workspace

  • AWS::FinSpace::Environment

  • AWS::Glue::Table

  • AWS::GuardDuty::Detector

  • AWS::KendraRanking::ExecutionPlan

  • AWS::ManagedBlockchain::Node

  • AWS::SageMaker::ExperimentTrialComponent

  • AWS::SageMaker::FeatureGroup

  • AWS::S3::AccessPoint

  • AWS::S3ObjectLambda::AccessPoint

  • 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. 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::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::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::CloudTrail::Channel, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

  • arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>

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

  • arn:<partition>:codewhisperer:<region>:<account_ID>:profile/<profile_ID>

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

  • arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_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::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::EMRWAL::Workspace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

  • arn:<partition>:emrwal:<region>::workspace/<workspace_name>

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

  • arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>

  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>

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

  • arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>

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

  • arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>

  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::SageMaker::ExperimentTrialComponent, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

  • arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>

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

  • arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>

  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::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::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 a CloudTrail event record on which to filter events to be logged. For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.

For CloudTrail event records, supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is eventCategory.

• readOnly - Optional. Can be set to Equals a value of true or false. If you do not add this field, CloudTrail logs 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 and must be set to Equals.

  • For CloudTrail event records, the value must be Management or Data.

  • For Config configuration items, the value must be ConfigurationItem.

  • For Audit Manager evidence, the value must be Evidence.

  • For non-Amazon Web Services events, the value must be ActivityAuditLog.

• resources.type - This field is required for CloudTrail data events. resources.type can only use the Equals operator, and the value can be one of the following:

  • AWS::DynamoDB::Table

  • AWS::Lambda::Function

  • AWS::S3::Object

  • AWS::CloudTrail::Channel

  • AWS::CodeWhisperer::Profile

  • AWS::Cognito::IdentityPool

  • AWS::DynamoDB::Stream

  • AWS::EC2::Snapshot

  • AWS::EMRWAL::Workspace

  • AWS::FinSpace::Environment

  • AWS::Glue::Table

  • AWS::GuardDuty::Detector

  • AWS::KendraRanking::ExecutionPlan

  • AWS::ManagedBlockchain::Node

  • AWS::SageMaker::ExperimentTrialComponent

  • AWS::SageMaker::FeatureGroup

  • AWS::S3::AccessPoint

  • AWS::S3ObjectLambda::AccessPoint

  • 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. 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::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::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::CloudTrail::Channel, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

  • arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>

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

  • arn:<partition>:codewhisperer:<region>:<account_ID>:profile/<profile_ID>

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

  • arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_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::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::EMRWAL::Workspace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

  • arn:<partition>:emrwal:<region>::workspace/<workspace_name>

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

  • arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>

  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>

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

  • arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>

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

  • arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>

  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::SageMaker::ExperimentTrialComponent, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

  • arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>

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

  • arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>

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

hasEqualsValue

public final boolean hasEqualsValue()

For responses, this returns true if the service returned a value for the Equals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

equalsValue

public final List<String> equalsValue()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEqualsValue() method.

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.

hasStartsWith

public final boolean hasStartsWith()

For responses, this returns true if the service returned a value for the StartsWith property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

startsWith

public final List<String> startsWith()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStartsWith() method.

Returns:

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

hasEndsWith

public final boolean hasEndsWith()

For responses, this returns true if the service returned a value for the EndsWith property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

endsWith

public final List<String> endsWith()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEndsWith() method.

Returns:

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

hasNotEquals

public final boolean hasNotEquals()

For responses, this returns true if the service returned a value for the NotEquals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

notEquals

public final List<String> notEquals()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotEquals() method.

Returns:

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

hasNotStartsWith

public final boolean hasNotStartsWith()

For responses, this returns true if the service returned a value for the NotStartsWith property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

notStartsWith

public final List<String> notStartsWith()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotStartsWith() method.

Returns:

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

hasNotEndsWith

public final boolean hasNotEndsWith()

For responses, this returns true if the service returned a value for the NotEndsWith property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

notEndsWith

public final List<String> notEndsWith()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotEndsWith() method.

Returns:

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

toBuilder

public AdvancedFieldSelector.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>

builder

public static AdvancedFieldSelector.Builder builder()

serializableBuilderClass

public static Class<? extends AdvancedFieldSelector.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo