Package software.amazon.awscdk.services.cloudtrail

Interface CfnTrail.AdvancedFieldSelectorProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrail.AdvancedFieldSelectorProperty.Jsii$Proxy

Enclosing class:

CfnTrail

@Stability(Stable)
public static interface CfnTrail.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-trail-advancedfieldselector.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTrail.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 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, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , 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 filter in or filter out specific events. You can have multiple values for this field, 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 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 .
• errorCode - This field 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 field is required for CloudTrail data events. resources.type can only use the Equals operator.

For a list of available resource types for data events, see Data events in the AWS CloudTrail User Guide .

You can have only one resources.type field 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 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 data events 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.

• vpcEndpointId - This field 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-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-trail-advancedfieldselector.html#cfn-cloudtrail-trail-advancedfieldselector-startswith

builder

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

Returns:

a CfnTrail.AdvancedFieldSelectorProperty.Builder of CfnTrail.AdvancedFieldSelectorProperty