java.lang.Object

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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>

@Generated("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:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static interface

AdvancedFieldSelector.Builder
Method Summary

Modifier and Type

Method

Description

static AdvancedFieldSelector.Builder

builder()

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.

final boolean

equals(Object obj)

final boolean

equalsBySdkFields(Object obj)

Indicates whether some other object is "equal to" this one by SDK fields.

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.

final String

field()

A field in a CloudTrail event record on which to filter events to be logged.

final <T> Optional<T>

getValueForField(String fieldName, Class<T> clazz)

final boolean

hasEndsWith()

For responses, this returns true if the service returned a value for the EndsWith property.

final boolean

hasEqualsValue()

For responses, this returns true if the service returned a value for the Equals property.

final int

hashCode()

final boolean

hasNotEndsWith()

For responses, this returns true if the service returned a value for the NotEndsWith property.

final boolean

hasNotEquals()

For responses, this returns true if the service returned a value for the NotEquals property.

final boolean

hasNotStartsWith()

For responses, this returns true if the service returned a value for the NotStartsWith property.

final boolean

hasStartsWith()

For responses, this returns true if the service returned a value for the StartsWith property.

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.

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.

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.

final List<SdkField<?>>

sdkFields()

static Class<? extends AdvancedFieldSelector.Builder>

serializableBuilderClass()

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.

AdvancedFieldSelector.Builder

toBuilder()

Take this object and create a builder that contains all of the current property values of this object.

final String

toString()

Returns a string representation of this object.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

Method Details
- 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 CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
  
  For CloudTrail management events, supported fields include eventCategory (required), eventSource, and readOnly.
  
  For CloudTrail data events, supported fields include eventCategory (required), resources.type (required), eventName, readOnly, and resources.ARN.
  
  For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName, errorCode, and vpcEndpointId.
  
  For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
  
  readOnly - This is an optional field that is only used for management events and data events. This field can be set to Equals with 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 - This field is only used for management events and network activity events.
  
  For management events, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events.
  
  For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source.
  
  The following are valid values for network activity events:
  
  cloudtrail.amazonaws.com
  
  ec2.amazonaws.com
  
  kms.amazonaws.com
  
  secretsmanager.amazonaws.com
  
  eventName - This is an optional field that is only used for data events and network activity events. You can use any operator with eventName. You can use it to ﬁlter in or ﬁlter out specific events. You can have multiple values for this ﬁeld, separated by commas.
  
  eventCategory - This field is required and must be set to Equals.
  
  For CloudTrail management events, the value must be Management.
  
  For CloudTrail data events, the value must be Data.
  
  For CloudTrail network activity events, the value must be NetworkActivity.
  
  The following are used only for event data stores:
  
  For CloudTrail Insights events, the value must be Insight.
  
  For 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.
  
  errorCode - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied. errorCode can only use the Equals operator.
  
  resources.type - This ﬁeld is required for CloudTrail data events. resources.type can only use the Equals operator.
  
  The value can be one of the following:
  
  AWS::AppConfig::Configuration
  
  AWS::B2BI::Transformer
  
  AWS::Bedrock::AgentAlias
  
  AWS::Bedrock::FlowAlias
  
  AWS::Bedrock::Guardrail
  
  AWS::Bedrock::KnowledgeBase
  
  AWS::Cassandra::Table
  
  AWS::CloudFront::KeyValueStore
  
  AWS::CloudTrail::Channel
  
  AWS::CloudWatch::Metric
  
  AWS::CodeWhisperer::Customization
  
  AWS::CodeWhisperer::Profile
  
  AWS::Cognito::IdentityPool
  
  AWS::DynamoDB::Stream
  
  AWS::DynamoDB::Table
  
  AWS::EC2::Snapshot
  
  AWS::EMRWAL::Workspace
  
  AWS::FinSpace::Environment
  
  AWS::Glue::Table
  
  AWS::GreengrassV2::ComponentVersion
  
  AWS::GreengrassV2::Deployment
  
  AWS::GuardDuty::Detector
  
  AWS::IoT::Certificate
  
  AWS::IoT::Thing
  
  AWS::IoTSiteWise::Asset
  
  AWS::IoTSiteWise::TimeSeries
  
  AWS::IoTTwinMaker::Entity
  
  AWS::IoTTwinMaker::Workspace
  
  AWS::KendraRanking::ExecutionPlan
  
  AWS::Kinesis::Stream
  
  AWS::Kinesis::StreamConsumer
  
  AWS::KinesisVideo::Stream
  
  AWS::Lambda::Function
  
  AWS::MachineLearning::MlModel
  
  AWS::ManagedBlockchain::Network
  
  AWS::ManagedBlockchain::Node
  
  AWS::MedicalImaging::Datastore
  
  AWS::NeptuneGraph::Graph
  
  AWS::One::UKey
  
  AWS::One::User
  
  AWS::PaymentCryptography::Alias
  
  AWS::PaymentCryptography::Key
  
  AWS::PCAConnectorAD::Connector
  
  AWS::PCAConnectorSCEP::Connector
  
  AWS::QApps:QApp
  
  AWS::QBusiness::Application
  
  AWS::QBusiness::DataSource
  
  AWS::QBusiness::Index
  
  AWS::QBusiness::WebExperience
  
  AWS::RDS::DBCluster
  
  AWS::RUM::AppMonitor
  
  AWS::S3::AccessPoint
  
  AWS::S3::Object
  
  AWS::S3Express::Object
  
  AWS::S3ObjectLambda::AccessPoint
  
  AWS::S3Outposts::Object
  
  AWS::SageMaker::Endpoint
  
  AWS::SageMaker::ExperimentTrialComponent
  
  AWS::SageMaker::FeatureGroup
  
  AWS::ServiceDiscovery::Namespace
  
  AWS::ServiceDiscovery::Service
  
  AWS::SCN::Instance
  
  AWS::SNS::PlatformEndpoint
  
  AWS::SNS::Topic
  
  AWS::SQS::Queue
  
  AWS::SSM::ManagedNode
  
  AWS::SSMMessages::ControlChannel
  
  AWS::StepFunctions::StateMachine
  
  AWS::SWF::Domain
  
  AWS::ThinClient::Device
  
  AWS::ThinClient::Environment
  
  AWS::Timestream::Database
  
  AWS::Timestream::Table
  
  AWS::VerifiedPermissions::PolicyStore
  
  AWS::XRay::Trace
  
  You can have only one resources.type ﬁeld per selector. To log events on more than one resource type, add another selector.
  
  resources.ARN - The resources.ARN is an optional field for data events. 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 speciﬁed in the template as the value of resources.type. 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.
  
  For information about filtering data events on the resources.ARN field, see Filtering data events by resources.ARN in the CloudTrail User Guide.
  
  You can't use the resources.ARN field to filter resource types that do not have ARNs.
  
  vpcEndpointId - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId.
  
  Returns:
  
  A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
  
  For CloudTrail management events, supported fields include eventCategory (required), eventSource, and readOnly.
  
  For CloudTrail data events, supported fields include eventCategory (required), resources.type (required), eventName, readOnly, and resources.ARN.
  
  For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName, errorCode, and vpcEndpointId.
  
  For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
  
  readOnly - This is an optional field that is only used for management events and data events. This field can be set to Equals with 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 - This field is only used for management events and network activity events.
  
  For management events, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events.
  
  For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source.
  
  The following are valid values for network activity events:
  
  cloudtrail.amazonaws.com
  
  ec2.amazonaws.com
  
  kms.amazonaws.com
  
  secretsmanager.amazonaws.com
  
  eventName - This is an optional field that is only used for data events and network activity events. You can use any operator with eventName. You can use it to ﬁlter in or ﬁlter out specific events. You can have multiple values for this ﬁeld, separated by commas.
  
  eventCategory - This field is required and must be set to Equals.
  
  For CloudTrail management events, the value must be Management.
  
  For CloudTrail data events, the value must be Data.
  
  For CloudTrail network activity events, the value must be NetworkActivity.
  
  The following are used only for event data stores:
  
  For CloudTrail Insights events, the value must be Insight.
  
  For 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.
  
  errorCode - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied. errorCode can only use the Equals operator.
  
  resources.type - This ﬁeld is required for CloudTrail data events. resources.type can only use the Equals operator.
  
  The value can be one of the following:
  
  AWS::AppConfig::Configuration
  
  AWS::B2BI::Transformer
  
  AWS::Bedrock::AgentAlias
  
  AWS::Bedrock::FlowAlias
  
  AWS::Bedrock::Guardrail
  
  AWS::Bedrock::KnowledgeBase
  
  AWS::Cassandra::Table
  
  AWS::CloudFront::KeyValueStore
  
  AWS::CloudTrail::Channel
  
  AWS::CloudWatch::Metric
  
  AWS::CodeWhisperer::Customization
  
  AWS::CodeWhisperer::Profile
  
  AWS::Cognito::IdentityPool
  
  AWS::DynamoDB::Stream
  
  AWS::DynamoDB::Table
  
  AWS::EC2::Snapshot
  
  AWS::EMRWAL::Workspace
  
  AWS::FinSpace::Environment
  
  AWS::Glue::Table
  
  AWS::GreengrassV2::ComponentVersion
  
  AWS::GreengrassV2::Deployment
  
  AWS::GuardDuty::Detector
  
  AWS::IoT::Certificate
  
  AWS::IoT::Thing
  
  AWS::IoTSiteWise::Asset
  
  AWS::IoTSiteWise::TimeSeries
  
  AWS::IoTTwinMaker::Entity
  
  AWS::IoTTwinMaker::Workspace
  
  AWS::KendraRanking::ExecutionPlan
  
  AWS::Kinesis::Stream
  
  AWS::Kinesis::StreamConsumer
  
  AWS::KinesisVideo::Stream
  
  AWS::Lambda::Function
  
  AWS::MachineLearning::MlModel
  
  AWS::ManagedBlockchain::Network
  
  AWS::ManagedBlockchain::Node
  
  AWS::MedicalImaging::Datastore
  
  AWS::NeptuneGraph::Graph
  
  AWS::One::UKey
  
  AWS::One::User
  
  AWS::PaymentCryptography::Alias
  
  AWS::PaymentCryptography::Key
  
  AWS::PCAConnectorAD::Connector
  
  AWS::PCAConnectorSCEP::Connector
  
  AWS::QApps:QApp
  
  AWS::QBusiness::Application
  
  AWS::QBusiness::DataSource
  
  AWS::QBusiness::Index
  
  AWS::QBusiness::WebExperience
  
  AWS::RDS::DBCluster
  
  AWS::RUM::AppMonitor
  
  AWS::S3::AccessPoint
  
  AWS::S3::Object
  
  AWS::S3Express::Object
  
  AWS::S3ObjectLambda::AccessPoint
  
  AWS::S3Outposts::Object
  
  AWS::SageMaker::Endpoint
  
  AWS::SageMaker::ExperimentTrialComponent
  
  AWS::SageMaker::FeatureGroup
  
  AWS::ServiceDiscovery::Namespace
  
  AWS::ServiceDiscovery::Service
  
  AWS::SCN::Instance
  
  AWS::SNS::PlatformEndpoint
  
  AWS::SNS::Topic
  
  AWS::SQS::Queue
  
  AWS::SSM::ManagedNode
  
  AWS::SSMMessages::ControlChannel
  
  AWS::StepFunctions::StateMachine
  
  AWS::SWF::Domain
  
  AWS::ThinClient::Device
  
  AWS::ThinClient::Environment
  
  AWS::Timestream::Database
  
  AWS::Timestream::Table
  
  AWS::VerifiedPermissions::PolicyStore
  
  AWS::XRay::Trace
  
  You can have only one resources.type ﬁeld per selector. To log events on more than one resource type, add another selector.
  
  resources.ARN - The resources.ARN is an optional field for data events. 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 speciﬁed in the template as the value of resources.type. 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.
  
  For information about filtering data events on the resources.ARN field, see Filtering data events by resources.ARN in the CloudTrail User Guide.
  
  You can't use the resources.ARN field to filter resource types that do not have ARNs.
  
  vpcEndpointId - This ﬁeld is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId.
- 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()
  
  Description copied from interface: ToCopyableBuilder
  
  Take this object and create a builder that contains all of the current property values of this object.
  
  Specified by:
  
  toBuilder in interface ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>
  
  Returns:
  
  a builder for type T
- 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)
  
  Description copied from interface: SdkPojo
  
  Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
  If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
  
  Specified by:
  
  equalsBySdkFields in interface SdkPojo
  
  Parameters:
  
  obj - the object to be compared with
  
  Returns:
  
  true if the other object equals to this object by sdk fields, false otherwise.
- 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
  
  Returns:
  
  List of SdkField in this POJO. May be empty list but should never be null.

Class AdvancedFieldSelector

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Details

field

hasEqualsValue

equalsValue

hasStartsWith

startsWith

hasEndsWith

endsWith

hasNotEquals

notEquals

hasNotStartsWith

notStartsWith

hasNotEndsWith

notEndsWith

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields