event_configurations

Creates, updates, deletes, gets or lists an event_configurations resource.

Overview

Name	event_configurations
Type	Resource
Id	aws.cloudtrail.event_configurations

Fields

The following fields are returned by SELECT queries:

get_event_configuration

Name	Datatype	Description
aggregation_configurations	array	The list of aggregation configurations that are configured for the trail.
context_key_selectors	array	The list of context key selectors that are configured for the event data store.
event_data_store_arn	string	The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which the event configuration settings are returned. (pattern: <code>^[a-zA-Z0-9._/-:]+$</code>)
max_event_size	string	The maximum allowed size for events stored in the specified event data store. (Standard, Large)
trail_arn	string	The Amazon Resource Name (ARN) of the trail for which the event configuration settings are returned.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_event_configuration	select	region		Retrieves the current event configuration settings for the specified event data store or trail. The response includes maximum event size configuration, the context key selectors configured for the event data store, and any aggregation settings configured for the trail.
put_event_configuration	replace	region		Updates the event configuration settings for the specified event data store or trail. This operation supports updating the maximum event size, adding or modifying context key selectors for event data store, and configuring aggregation settings for the trail.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_event_configuration

Retrieves the current event configuration settings for the specified event data store or trail. The response includes maximum event size configuration, the context key selectors configured for the event data store, and any aggregation settings configured for the trail.

SELECT
aggregation_configurations,
context_key_selectors,
event_data_store_arn,
max_event_size,
trail_arn
FROM aws.cloudtrail.event_configurations
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_event_configuration

Updates the event configuration settings for the specified event data store or trail. This operation supports updating the maximum event size, adding or modifying context key selectors for event data store, and configuring aggregation settings for the trail.

REPLACE aws.cloudtrail.event_configurations
SET 
TrailName = '{{ TrailName }}',
EventDataStore = '{{ EventDataStore }}',
MaxEventSize = '{{ MaxEventSize }}',
ContextKeySelectors = '{{ ContextKeySelectors }}',
AggregationConfigurations = '{{ AggregationConfigurations }}'
WHERE 
region = '{{ region }}' --required
RETURNING
aggregation_configurations,
context_key_selectors,
event_data_store_arn,
max_event_size,
trail_arn;