Package software.amazon.awscdk.services.cloudtrail

Interface CfnTrail.EventSelectorProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrail.EventSelectorProperty.Jsii$Proxy

Enclosing class:

CfnTrail

@Stability(Stable)
public static interface CfnTrail.EventSelectorProperty
extends software.amazon.jsii.JsiiSerializable

Use event selectors to further specify the management and data event settings for your trail.

By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

You can configure up to five event selectors for a trail.

You cannot apply both event selectors and advanced event selectors to a trail.

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.*;
 EventSelectorProperty eventSelectorProperty = EventSelectorProperty.builder()
         .dataResources(List.of(DataResourceProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .values(List.of("values"))
                 .build()))
         .excludeManagementEventSources(List.of("excludeManagementEventSources"))
         .includeManagementEvents(false)
         .readWriteType("readWriteType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTrail.EventSelectorProperty.Builder	builder()
default Object	getDataResources()	CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors.
default List<String>	getExcludeManagementEventSources()	An optional list of service event sources from which you do not want management events to be logged on your trail.
default Object	getIncludeManagementEvents()	Specify if you want your event selector to include management events for your trail.
default String	getReadWriteType()	Specify if you want your trail to log read-only events, write-only events, or all.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataResources

@Stability(Stable)
@Nullable
default Object getDataResources()

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors.

You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

For more information, see Data Events and Limits in AWS CloudTrail in the AWS CloudTrail User Guide .

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-dataresources

getExcludeManagementEventSources

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

An optional list of service event sources from which you do not want management events to be logged on your trail.

In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com . By default, ExcludeManagementEventSources is empty, and AWS KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-excludemanagementeventsources

getIncludeManagementEvents

@Stability(Stable)
@Nullable
default Object getIncludeManagementEvents()

Specify if you want your event selector to include management events for your trail.

For more information, see Management Events in the AWS CloudTrail User Guide .

By default, the value is true .

The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see AWS CloudTrail Pricing .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-includemanagementevents

getReadWriteType

@Stability(Stable)
@Nullable
default String getReadWriteType()

Specify if you want your trail to log read-only events, write-only events, or all.

For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

By default, the value is All .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-readwritetype

builder

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

Returns:

a CfnTrail.EventSelectorProperty.Builder of CfnTrail.EventSelectorProperty