software.amazon.awssdk.services.cloudtrail.model

Class EventSelector

java.lang.Object

software.amazon.awssdk.services.cloudtrail.model.EventSelector

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EventSelector.Builder,EventSelector>

@Generated(value="software.amazon.awssdk:codegen")
public final class EventSelector
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EventSelector.Builder,EventSelector>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventSelector.Builder

Method Summary

Modifier and Type	Method and Description
static EventSelector.Builder	builder()
List<DataResource>	dataResources() CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	excludeManagementEventSources() An optional list of service event sources from which you do not want management events to be logged on your trail.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDataResources() Returns true if the DataResources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasExcludeManagementEventSources() Returns true if the ExcludeManagementEventSources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Boolean	includeManagementEvents() Specify if you want your event selector to include management events for your trail.
ReadWriteType	readWriteType() Specify if you want your trail to log read-only events, write-only events, or all.
String	readWriteTypeAsString() Specify if you want your trail to log read-only events, write-only events, or all.
List<SdkField<?>>	sdkFields()
static Class<? extends EventSelector.Builder>	serializableBuilderClass()
EventSelector.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

readWriteType

public final ReadWriteType readWriteType()

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.

If the service returns an enum value that is not available in the current SDK version, readWriteType will return ReadWriteType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from readWriteTypeAsString().

Returns:

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:

ReadWriteType

readWriteTypeAsString

public final String readWriteTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, readWriteType will return ReadWriteType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from readWriteTypeAsString().

Returns:

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:

ReadWriteType

includeManagementEvents

public final Boolean includeManagementEvents()

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.

Returns:

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.

hasDataResources

public final boolean hasDataResources()

Returns true if the DataResources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

dataResources

public final List<DataResource> dataResources()

CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDataResources() to see if a value was sent in this field.

Returns:

CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. 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.

hasExcludeManagementEventSources

public final boolean hasExcludeManagementEventSources()

Returns true if the ExcludeManagementEventSources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

excludeManagementEventSources

public final List<String> excludeManagementEventSources()

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 events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasExcludeManagementEventSources() to see if a value was sent in this field.

Returns:

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 events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.

toBuilder

public EventSelector.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EventSelector.Builder,EventSelector>

builder

public static EventSelector.Builder builder()

serializableBuilderClass

public static Class<? extends EventSelector.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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