Amazonka.CloudTrail.Types.EventSelector

Documentation

data 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: newEventSelector smart constructor.

Constructors

EventSelector'

Fields

• dataResources :: Maybe [DataResource]

  CloudTrail supports data event logging for Amazon S3 objects, 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 CloudTrail in the CloudTrail User Guide.

• excludeManagementEventSources :: Maybe [Text]

  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 Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and 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.

• includeManagementEvents :: Maybe Bool

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

  For more information, see Management Events in the 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 CloudTrail Pricing.

• readWriteType :: Maybe 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.

Instances

FromJSON EventSelector

Defined in Amazonka.CloudTrail.Types.EventSelector

Methods

parseJSON :: Value -> Parser EventSelector

parseJSONList :: Value -> Parser [EventSelector]

ToJSON EventSelector

Defined in Amazonka.CloudTrail.Types.EventSelector

Methods

toJSON :: EventSelector -> Value

toEncoding :: EventSelector -> Encoding

toJSONList :: [EventSelector] -> Value

toEncodingList :: [EventSelector] -> Encoding

Generic EventSelector

Defined in Amazonka.CloudTrail.Types.EventSelector

Associated Types

type Rep EventSelector :: Type -> Type

Methods

from :: EventSelector -> Rep EventSelector x

to :: Rep EventSelector x -> EventSelector

Read EventSelector

Defined in Amazonka.CloudTrail.Types.EventSelector

Methods

readsPrec :: Int -> ReadS EventSelector

readList :: ReadS [EventSelector]

readPrec :: ReadPrec EventSelector

readListPrec :: ReadPrec [EventSelector]

Show EventSelector

Defined in Amazonka.CloudTrail.Types.EventSelector

Methods

showsPrec :: Int -> EventSelector -> ShowS

show :: EventSelector -> String

showList :: [EventSelector] -> ShowS

NFData EventSelector

Defined in Amazonka.CloudTrail.Types.EventSelector

Methods

rnf :: EventSelector -> ()

Eq EventSelector

Defined in Amazonka.CloudTrail.Types.EventSelector

Methods

(==) :: EventSelector -> EventSelector -> Bool

(/=) :: EventSelector -> EventSelector -> Bool

Hashable EventSelector

Defined in Amazonka.CloudTrail.Types.EventSelector

Methods

hashWithSalt :: Int -> EventSelector -> Int

hash :: EventSelector -> Int

type Rep EventSelector

Defined in Amazonka.CloudTrail.Types.EventSelector

type Rep EventSelector = D1 ('MetaData "EventSelector" "Amazonka.CloudTrail.Types.EventSelector" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "EventSelector'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataResource])) :*: S1 ('MetaSel ('Just "excludeManagementEventSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "includeManagementEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "readWriteType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReadWriteType)))))

newEventSelector :: EventSelector

Create a value of EventSelector with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataResources:EventSelector', eventSelector_dataResources - CloudTrail supports data event logging for Amazon S3 objects, 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 CloudTrail in the CloudTrail User Guide.

$sel:excludeManagementEventSources:EventSelector', eventSelector_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 Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and 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.

$sel:includeManagementEvents:EventSelector', eventSelector_includeManagementEvents - Specify if you want your event selector to include management events for your trail.

For more information, see Management Events in the 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 CloudTrail Pricing.

$sel:readWriteType:EventSelector', eventSelector_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.

eventSelector_dataResources :: Lens' EventSelector (Maybe [DataResource])

CloudTrail supports data event logging for Amazon S3 objects, 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 CloudTrail in the CloudTrail User Guide.

eventSelector_excludeManagementEventSources :: Lens' EventSelector (Maybe [Text])

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 Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and 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.

eventSelector_includeManagementEvents :: Lens' EventSelector (Maybe Bool)

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

For more information, see Management Events in the 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 CloudTrail Pricing.

eventSelector_readWriteType :: Lens' EventSelector (Maybe 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.