EventSelector (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudtrail.model.EventSelector

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EventSelector
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EventSelector()

Constructors
Constructor and Description
`EventSelector()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EventSelector`	`clone()`
`boolean`	`equals(Object obj)`
`List<DataResource>`	`getDataResources()` CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions.
`List<String>`	`getExcludeManagementEventSources()` An optional list of service event sources from which you do not want management events to be logged on your trail.
`Boolean`	`getIncludeManagementEvents()` Specify if you want your event selector to include management events for your trail.
`String`	`getReadWriteType()` Specify if you want your trail to log read-only events, write-only events, or all.
`int`	`hashCode()`
`Boolean`	`isIncludeManagementEvents()` Specify if you want your event selector to include management events for your trail.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataResources(Collection<DataResource> dataResources)` CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions.
`void`	`setExcludeManagementEventSources(Collection<String> excludeManagementEventSources)` An optional list of service event sources from which you do not want management events to be logged on your trail.
`void`	`setIncludeManagementEvents(Boolean includeManagementEvents)` Specify if you want your event selector to include management events for your trail.
`void`	`setReadWriteType(ReadWriteType readWriteType)` Specify if you want your trail to log read-only events, write-only events, or all.
`void`	`setReadWriteType(String readWriteType)` Specify if you want your trail to log read-only events, write-only events, or all.
`String`	`toString()` Returns a string representation of this object.
`EventSelector`	`withDataResources(Collection<DataResource> dataResources)` CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions.
`EventSelector`	`withDataResources(DataResource... dataResources)` CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions.
`EventSelector`	`withExcludeManagementEventSources(Collection<String> excludeManagementEventSources)` An optional list of service event sources from which you do not want management events to be logged on your trail.
`EventSelector`	`withExcludeManagementEventSources(String... excludeManagementEventSources)` An optional list of service event sources from which you do not want management events to be logged on your trail.
`EventSelector`	`withIncludeManagementEvents(Boolean includeManagementEvents)` Specify if you want your event selector to include management events for your trail.
`EventSelector`	`withReadWriteType(ReadWriteType readWriteType)` Specify if you want your trail to log read-only events, write-only events, or all.
`EventSelector`	`withReadWriteType(String readWriteType)` Specify if you want your trail to log read-only events, write-only events, or all.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EventSelector
```
public EventSelector()
```
- Method Detail
  - setReadWriteType
```
public void setReadWriteType(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ReadWriteType
  - getReadWriteType
```
public 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.
    
    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
  - withReadWriteType
```
public EventSelector withReadWriteType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReadWriteType
  - setReadWriteType
```
public void setReadWriteType(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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ReadWriteType
  - withReadWriteType
```
public EventSelector withReadWriteType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReadWriteType
  - setIncludeManagementEvents
```
public void setIncludeManagementEvents(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.
    
    Parameters:
    
    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.
  - getIncludeManagementEvents
```
public Boolean 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.
    
    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.
  - withIncludeManagementEvents
```
public EventSelector withIncludeManagementEvents(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeManagementEvents
```
public Boolean isIncludeManagementEvents()
```
    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.
  - getDataResources
```
public List<DataResource> getDataResources()
```
    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.
    
    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.
  - setDataResources
```
public void setDataResources(Collection<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.
    
    Parameters:
    
    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.
  - withDataResources
```
public EventSelector withDataResources(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setDataResources(java.util.Collection) or withDataResources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDataResources
```
public EventSelector withDataResources(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludeManagementEventSources
```
public 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 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.
    
    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.
  - setExcludeManagementEventSources
```
public void setExcludeManagementEventSources(Collection<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.
    
    Parameters:
    
    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.
  - withExcludeManagementEventSources
```
public EventSelector withExcludeManagementEventSources(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setExcludeManagementEventSources(java.util.Collection) or withExcludeManagementEventSources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludeManagementEventSources
```
public EventSelector withExcludeManagementEventSources(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EventSelector clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class EventSelector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventSelector

Method Detail

setReadWriteType

getReadWriteType

withReadWriteType

setReadWriteType

withReadWriteType

setIncludeManagementEvents

getIncludeManagementEvents

withIncludeManagementEvents

isIncludeManagementEvents

getDataResources

setDataResources

withDataResources

withDataResources

getExcludeManagementEventSources

setExcludeManagementEventSources

withExcludeManagementEventSources

withExcludeManagementEventSources

toString

equals

hashCode

clone

marshall