Class AdvancedFieldSelector
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AdvancedFieldSelector.Builder,
AdvancedFieldSelector>
A single selector statement in an advanced event selector.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
endsWith()
An operator that includes events that match the last few characters of the event record field specified as the value ofField
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.An operator that includes events that match the exact value of the event record field specified as the value ofField
.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
For responses, this returns true if the service returned a value for the EndsWith property.final boolean
For responses, this returns true if the service returned a value for the Equals property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NotEndsWith property.final boolean
For responses, this returns true if the service returned a value for the NotEquals property.final boolean
For responses, this returns true if the service returned a value for the NotStartsWith property.final boolean
For responses, this returns true if the service returned a value for the StartsWith property.An operator that excludes events that match the last few characters of the event record field specified as the value ofField
.An operator that excludes events that match the exact value of the event record field specified as the value ofField
.An operator that excludes events that match the first few characters of the event record field specified as the value ofField
.static Class
<? extends AdvancedFieldSelector.Builder> An operator that includes events that match the first few characters of the event record field specified as the value ofField
.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
readOnly
,eventCategory
, andeventSource
.For CloudTrail data events, supported fields include
readOnly
,eventCategory
,eventName
,resources.type
, andresources.ARN
.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
- Optional. Can be set toEquals
a value oftrue
orfalse
. If you do not add this field, CloudTrail logs bothread
andwrite
events. A value oftrue
logs onlyread
events. A value offalse
logs onlywrite
events. -
eventSource
- For filtering management events only. This can be set toNotEquals
kms.amazonaws.com
orNotEquals
rdsdata.amazonaws.com
. -
eventName
- Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such asPutBucket
orGetSnapshotBlock
. You can have multiple values for this field, separated by commas. -
eventCategory
- This is required and must be set toEquals
.-
For CloudTrail management events, the value must be
Management
. -
For CloudTrail data events, the value must be
Data
.
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
.
-
-
resources.type
- This field is required for CloudTrail data events.resources.type
can only use theEquals
operator, and the value can be one of the following:-
AWS::DynamoDB::Table
-
AWS::Lambda::Function
-
AWS::S3::Object
-
AWS::AppConfig::Configuration
-
AWS::B2BI::Transformer
-
AWS::Bedrock::AgentAlias
-
AWS::Bedrock::KnowledgeBase
-
AWS::Cassandra::Table
-
AWS::CloudFront::KeyValueStore
-
AWS::CloudTrail::Channel
-
AWS::CodeWhisperer::Customization
-
AWS::CodeWhisperer::Profile
-
AWS::Cognito::IdentityPool
-
AWS::DynamoDB::Stream
-
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::KinesisVideo::Stream
-
AWS::ManagedBlockchain::Network
-
AWS::ManagedBlockchain::Node
-
AWS::MedicalImaging::Datastore
-
AWS::NeptuneGraph::Graph
-
AWS::PCAConnectorAD::Connector
-
AWS::QBusiness::Application
-
AWS::QBusiness::DataSource
-
AWS::QBusiness::Index
-
AWS::QBusiness::WebExperience
-
AWS::RDS::DBCluster
-
AWS::S3::AccessPoint
-
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::SWF::Domain
-
AWS::SQS::Queue
-
AWS::SSMMessages::ControlChannel
-
AWS::ThinClient::Device
-
AWS::ThinClient::Environment
-
AWS::Timestream::Database
-
AWS::Timestream::Table
-
AWS::VerifiedPermissions::PolicyStore
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 withresources.ARN
, but if you useEquals
orNotEquals
, 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 equalsAWS::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 theStartsWith
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 toEquals
orNotEquals
, 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 toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals
AWS::AppConfig::Configuration
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>
When resources.type equals
AWS::B2BI::Transformer
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>
When resources.type equals
AWS::Bedrock::AgentAlias
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>
When resources.type equals
AWS::Bedrock::KnowledgeBase
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>
When resources.type equals
AWS::Cassandra::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>
When resources.type equals
AWS::CloudFront::KeyValueStore
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_name>
When resources.type equals
AWS::CloudTrail::Channel
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>
When resources.type equals
AWS::CodeWhisperer::Customization
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>
When resources.type equals
AWS::CodeWhisperer::Profile
, and the operator is set toEquals
orNotEquals
, 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 toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_ID>
When
resources.type
equalsAWS::DynamoDB::Stream
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When
resources.type
equalsAWS::EC2::Snapshot
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When
resources.type
equalsAWS::EMRWAL::Workspace
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:emrwal:<region>:<account_ID>:workspace/<workspace_name>
When
resources.type
equalsAWS::FinSpace::Environment
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>
When
resources.type
equalsAWS::Glue::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
When
resources.type
equalsAWS::GreengrassV2::ComponentVersion
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>
When
resources.type
equalsAWS::GreengrassV2::Deployment
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID
When
resources.type
equalsAWS::GuardDuty::Detector
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>
When
resources.type
equalsAWS::IoT::Certificate
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>
When
resources.type
equalsAWS::IoT::Thing
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>
When
resources.type
equalsAWS::IoTSiteWise::Asset
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>
When
resources.type
equalsAWS::IoTSiteWise::TimeSeries
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>
When
resources.type
equalsAWS::IoTTwinMaker::Entity
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>
When
resources.type
equalsAWS::IoTTwinMaker::Workspace
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>
When
resources.type
equalsAWS::KendraRanking::ExecutionPlan
, and the operator is set toEquals
orNotEquals
, 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
equalsAWS::KinesisVideo::Stream
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>
When
resources.type
equalsAWS::ManagedBlockchain::Network
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:managedblockchain:::networks/<network_name>
When
resources.type
equalsAWS::ManagedBlockchain::Node
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When
resources.type
equalsAWS::MedicalImaging::Datastore
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>
When
resources.type
equalsAWS::NeptuneGraph::Graph
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>
When
resources.type
equalsAWS::PCAConnectorAD::Connector
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>
When
resources.type
equalsAWS::QBusiness::Application
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>
When
resources.type
equalsAWS::QBusiness::DataSource
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>
When
resources.type
equalsAWS::QBusiness::Index
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>
When
resources.type
equalsAWS::QBusiness::WebExperience
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>
When
resources.type
equalsAWS::RDS::DBCluster
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_name>
When
resources.type
equalsAWS::S3::AccessPoint
, and the operator is set toEquals
orNotEquals
, 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 theStartsWith
orNotStartsWith
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
equalsAWS::S3ObjectLambda::AccessPoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When
resources.type
equalsAWS::S3Outposts::Object
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When
resources.type
equalsAWS::SageMaker::Endpoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>
When
resources.type
equalsAWS::SageMaker::ExperimentTrialComponent
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>
When
resources.type
equalsAWS::SageMaker::FeatureGroup
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>
When
resources.type
equalsAWS::SCN::Instance
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>
When
resources.type
equalsAWS::ServiceDiscovery::Namespace
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>
When
resources.type
equalsAWS::ServiceDiscovery::Service
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>
When
resources.type
equalsAWS::SNS::PlatformEndpoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>
When
resources.type
equalsAWS::SNS::Topic
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sns:<region>:<account_ID>:<topic_name>
When
resources.type
equalsAWS::SWF::Domain
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>
When
resources.type
equalsAWS::SQS::Queue
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sqs:<region>:<account_ID>:<queue_name>
When
resources.type
equalsAWS::SSMMessages::ControlChannel
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>
When
resources.type
equalsAWS::ThinClient::Device
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>
When
resources.type
equalsAWS::ThinClient::Environment
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:thinclient:<region>:<account_ID>:environment/<environment_ID>
When
resources.type
equalsAWS::Timestream::Database
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>
When
resources.type
equalsAWS::Timestream::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>
When resources.type equals
AWS::VerifiedPermissions::PolicyStore
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>
-
- 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
readOnly
,eventCategory
, andeventSource
.For CloudTrail data events, supported fields include
readOnly
,eventCategory
,eventName
,resources.type
, andresources.ARN
.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
- Optional. Can be set toEquals
a value oftrue
orfalse
. If you do not add this field, CloudTrail logs bothread
andwrite
events. A value oftrue
logs onlyread
events. A value offalse
logs onlywrite
events. -
eventSource
- For filtering management events only. This can be set toNotEquals
kms.amazonaws.com
orNotEquals
rdsdata.amazonaws.com
. -
eventName
- Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such asPutBucket
orGetSnapshotBlock
. You can have multiple values for this field, separated by commas. -
eventCategory
- This is required and must be set toEquals
.-
For CloudTrail management events, the value must be
Management
. -
For CloudTrail data events, the value must be
Data
.
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
.
-
-
resources.type
- This field is required for CloudTrail data events.resources.type
can only use theEquals
operator, and the value can be one of the following:-
AWS::DynamoDB::Table
-
AWS::Lambda::Function
-
AWS::S3::Object
-
AWS::AppConfig::Configuration
-
AWS::B2BI::Transformer
-
AWS::Bedrock::AgentAlias
-
AWS::Bedrock::KnowledgeBase
-
AWS::Cassandra::Table
-
AWS::CloudFront::KeyValueStore
-
AWS::CloudTrail::Channel
-
AWS::CodeWhisperer::Customization
-
AWS::CodeWhisperer::Profile
-
AWS::Cognito::IdentityPool
-
AWS::DynamoDB::Stream
-
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::KinesisVideo::Stream
-
AWS::ManagedBlockchain::Network
-
AWS::ManagedBlockchain::Node
-
AWS::MedicalImaging::Datastore
-
AWS::NeptuneGraph::Graph
-
AWS::PCAConnectorAD::Connector
-
AWS::QBusiness::Application
-
AWS::QBusiness::DataSource
-
AWS::QBusiness::Index
-
AWS::QBusiness::WebExperience
-
AWS::RDS::DBCluster
-
AWS::S3::AccessPoint
-
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::SWF::Domain
-
AWS::SQS::Queue
-
AWS::SSMMessages::ControlChannel
-
AWS::ThinClient::Device
-
AWS::ThinClient::Environment
-
AWS::Timestream::Database
-
AWS::Timestream::Table
-
AWS::VerifiedPermissions::PolicyStore
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 withresources.ARN
, but if you useEquals
orNotEquals
, 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 equalsAWS::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 theStartsWith
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 toEquals
orNotEquals
, 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 toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals
AWS::AppConfig::Configuration
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>
When resources.type equals
AWS::B2BI::Transformer
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>
When resources.type equals
AWS::Bedrock::AgentAlias
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>
When resources.type equals
AWS::Bedrock::KnowledgeBase
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>
When resources.type equals
AWS::Cassandra::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>
When resources.type equals
AWS::CloudFront::KeyValueStore
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_name>
When resources.type equals
AWS::CloudTrail::Channel
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>
When resources.type equals
AWS::CodeWhisperer::Customization
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>
When resources.type equals
AWS::CodeWhisperer::Profile
, and the operator is set toEquals
orNotEquals
, 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 toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_ID>
When
resources.type
equalsAWS::DynamoDB::Stream
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When
resources.type
equalsAWS::EC2::Snapshot
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When
resources.type
equalsAWS::EMRWAL::Workspace
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:emrwal:<region>:<account_ID>:workspace/<workspace_name>
When
resources.type
equalsAWS::FinSpace::Environment
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>
When
resources.type
equalsAWS::Glue::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
When
resources.type
equalsAWS::GreengrassV2::ComponentVersion
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>
When
resources.type
equalsAWS::GreengrassV2::Deployment
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID
When
resources.type
equalsAWS::GuardDuty::Detector
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>
When
resources.type
equalsAWS::IoT::Certificate
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>
When
resources.type
equalsAWS::IoT::Thing
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>
When
resources.type
equalsAWS::IoTSiteWise::Asset
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>
When
resources.type
equalsAWS::IoTSiteWise::TimeSeries
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>
When
resources.type
equalsAWS::IoTTwinMaker::Entity
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>
When
resources.type
equalsAWS::IoTTwinMaker::Workspace
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>
When
resources.type
equalsAWS::KendraRanking::ExecutionPlan
, and the operator is set toEquals
orNotEquals
, 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
equalsAWS::KinesisVideo::Stream
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>
When
resources.type
equalsAWS::ManagedBlockchain::Network
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:managedblockchain:::networks/<network_name>
When
resources.type
equalsAWS::ManagedBlockchain::Node
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When
resources.type
equalsAWS::MedicalImaging::Datastore
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>
When
resources.type
equalsAWS::NeptuneGraph::Graph
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>
When
resources.type
equalsAWS::PCAConnectorAD::Connector
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>
When
resources.type
equalsAWS::QBusiness::Application
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>
When
resources.type
equalsAWS::QBusiness::DataSource
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>
When
resources.type
equalsAWS::QBusiness::Index
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>
When
resources.type
equalsAWS::QBusiness::WebExperience
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>
When
resources.type
equalsAWS::RDS::DBCluster
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_name>
When
resources.type
equalsAWS::S3::AccessPoint
, and the operator is set toEquals
orNotEquals
, 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 theStartsWith
orNotStartsWith
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
equalsAWS::S3ObjectLambda::AccessPoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When
resources.type
equalsAWS::S3Outposts::Object
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When
resources.type
equalsAWS::SageMaker::Endpoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>
When
resources.type
equalsAWS::SageMaker::ExperimentTrialComponent
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>
When
resources.type
equalsAWS::SageMaker::FeatureGroup
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>
When
resources.type
equalsAWS::SCN::Instance
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>
When
resources.type
equalsAWS::ServiceDiscovery::Namespace
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>
When
resources.type
equalsAWS::ServiceDiscovery::Service
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>
When
resources.type
equalsAWS::SNS::PlatformEndpoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>
When
resources.type
equalsAWS::SNS::Topic
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sns:<region>:<account_ID>:<topic_name>
When
resources.type
equalsAWS::SWF::Domain
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>
When
resources.type
equalsAWS::SQS::Queue
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:sqs:<region>:<account_ID>:<queue_name>
When
resources.type
equalsAWS::SSMMessages::ControlChannel
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>
When
resources.type
equalsAWS::ThinClient::Device
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>
When
resources.type
equalsAWS::ThinClient::Environment
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:thinclient:<region>:<account_ID>:environment/<environment_ID>
When
resources.type
equalsAWS::Timestream::Database
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>
When
resources.type
equalsAWS::Timestream::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>
When resources.type equals
AWS::VerifiedPermissions::PolicyStore
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:-
arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>
-
-
-
-
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 theisEmpty()
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
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 thereadOnly
,eventCategory
, andresources.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 thereadOnly
,eventCategory
, andresources.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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<AdvancedFieldSelector.Builder,
AdvancedFieldSelector> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-