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.

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

readWriteType

public 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 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 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.

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.

dataResources

public 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.

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.

toBuilder

public EventSelector.Builder 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 interface ToCopyableBuilder<EventSelector.Builder,EventSelector>

Returns:

a builder for type T

builder

public static EventSelector.Builder builder()

serializableBuilderClass

public static Class<? extends EventSelector.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.