Package software.amazon.awscdk.services.cloudtrail

Interface CfnEventDataStore.AdvancedFieldSelectorProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventDataStore.AdvancedFieldSelectorProperty.Jsii$Proxy

Enclosing class:

CfnEventDataStore

@Stability(Stable)
public static interface CfnEventDataStore.AdvancedFieldSelectorProperty
extends software.amazon.jsii.JsiiSerializable

A single selector statement in an advanced event selector.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudtrail.*;
 AdvancedFieldSelectorProperty advancedFieldSelectorProperty = AdvancedFieldSelectorProperty.builder()
         .field("field")
         // the properties below are optional
         .endsWith(List.of("endsWith"))
         .equalTo(List.of("equalTo"))
         .notEndsWith(List.of("notEndsWith"))
         .notEquals(List.of("notEquals"))
         .notStartsWith(List.of("notStartsWith"))
         .startsWith(List.of("startsWith"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventDataStore.AdvancedFieldSelectorProperty.Builder	A builder for CfnEventDataStore.AdvancedFieldSelectorProperty
static final class	CfnEventDataStore.AdvancedFieldSelectorProperty.Jsii$Proxy	An implementation for CfnEventDataStore.AdvancedFieldSelectorProperty

Method Summary

Modifier and Type	Method	Description
static CfnEventDataStore.AdvancedFieldSelectorProperty.Builder	builder()
default List<String>	getEndsWith()	An operator that includes events that match the last few characters of the event record field specified as the value of Field .
default List<String>	getEqualTo()	An operator that includes events that match the exact value of the event record field specified as the value of Field .
String	getField()	A field in a CloudTrail event record on which to filter events to be logged.
default List<String>	getNotEndsWith()	An operator that excludes events that match the last few characters of the event record field specified as the value of Field .
default List<String>	getNotEquals()	An operator that excludes events that match the exact value of the event record field specified as the value of Field .
default List<String>	getNotStartsWith()	An operator that excludes events that match the first few characters of the event record field specified as the value of Field .
default List<String>	getStartsWith()	An operator that includes events that match the first few characters of the event record field specified as the value of Field .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getField

@Stability(Stable)
@NotNull
String getField()

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

For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported.

For CloudTrail management events, supported fields include readOnly , eventCategory , and eventSource .

For CloudTrail data events, supported fields include readOnly , eventCategory , eventName , resources.type , and resources.ARN .

For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , 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 to NotEquals kms.amazonaws.com or NotEquals 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 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 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 AWS Config configuration items, the value must be ConfigurationItem .
• For Audit Manager evidence, the value must be Evidence .
• For non- AWS 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::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 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. 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 on the resources.ARN field, see Filtering data events by resources.ARN in the AWS CloudTrail User Guide .

You can't use the resources.ARN field to filter resource types that do not have ARNs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-field

getEndsWith

@Stability(Stable)
@Nullable
default List<String> getEndsWith()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-endswith

getEqualTo

@Stability(Stable)
@Nullable
default List<String> getEqualTo()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-equals

getNotEndsWith

@Stability(Stable)
@Nullable
default List<String> getNotEndsWith()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notendswith

getNotEquals

@Stability(Stable)
@Nullable
default List<String> getNotEquals()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notequals

getNotStartsWith

@Stability(Stable)
@Nullable
default List<String> getNotStartsWith()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-notstartswith

getStartsWith

@Stability(Stable)
@Nullable
default List<String> getStartsWith()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html#cfn-cloudtrail-eventdatastore-advancedfieldselector-startswith

builder

@Stability(Stable)
static CfnEventDataStore.AdvancedFieldSelectorProperty.Builder builder()

Returns:

a CfnEventDataStore.AdvancedFieldSelectorProperty.Builder of CfnEventDataStore.AdvancedFieldSelectorProperty