CreateEventDataStore - AWS CloudTrail

CreateEventDataStore

Creates a new event data store.

Request Syntax

{ "AdvancedEventSelectors": [ { "FieldSelectors": [ { "EndsWith": [ "string" ], "Equals": [ "string" ], "Field": "string", "NotEndsWith": [ "string" ], "NotEquals": [ "string" ], "NotStartsWith": [ "string" ], "StartsWith": [ "string" ] } ], "Name": "string" } ], "KmsKeyId": "string", "MultiRegionEnabled": boolean, "Name": "string", "OrganizationEnabled": boolean, "RetentionPeriod": number, "StartIngestion": boolean, "TagsList": [ { "Key": "string", "Value": "string" } ], "TerminationProtectionEnabled": boolean }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AdvancedEventSelectors

The advanced event selectors to use to select the events for the data store. You can configure up to five advanced event selectors for each event data store.

For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see Create an event data store for AWS Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

Type: Array of AdvancedEventSelector objects

Required: No

KmsKeyId

Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Important

Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.

CloudTrail also supports AWS KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

Examples:

  • alias/MyAliasName

  • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName

  • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

  • 12345678-1234-1234-1234-123456789012

Type: String

Length Constraints: Minimum length of 1. Maximum length of 350.

Pattern: ^[a-zA-Z0-9._/\-:]+$

Required: No

MultiRegionEnabled

Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

Type: Boolean

Required: No

Name

The name of the event data store.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^[a-zA-Z0-9._\-]+$

Required: Yes

OrganizationEnabled

Specifies whether an event data store collects events logged for an organization in AWS Organizations.

Type: Boolean

Required: No

RetentionPeriod

The retention period of the event data store, in days. You can set a retention period of up to 2557 days, the equivalent of seven years. CloudTrail Lake determines whether to retain an event by checking if the eventTime of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the eventTime is older than 90 days.

Note

If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.

Type: Integer

Valid Range: Minimum value of 7. Maximum value of 2557.

Required: No

StartIngestion

Specifies whether the event data store should start ingesting live events. The default is true.

Type: Boolean

Required: No

TagsList

A list of tags.

Type: Array of Tag objects

Array Members: Maximum number of 200 items.

Required: No

TerminationProtectionEnabled

Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.

Type: Boolean

Required: No

Response Syntax

{ "AdvancedEventSelectors": [ { "FieldSelectors": [ { "EndsWith": [ "string" ], "Equals": [ "string" ], "Field": "string", "NotEndsWith": [ "string" ], "NotEquals": [ "string" ], "NotStartsWith": [ "string" ], "StartsWith": [ "string" ] } ], "Name": "string" } ], "CreatedTimestamp": number, "EventDataStoreArn": "string", "KmsKeyId": "string", "MultiRegionEnabled": boolean, "Name": "string", "OrganizationEnabled": boolean, "RetentionPeriod": number, "Status": "string", "TagsList": [ { "Key": "string", "Value": "string" } ], "TerminationProtectionEnabled": boolean, "UpdatedTimestamp": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AdvancedEventSelectors

The advanced event selectors that were used to select the events for the data store.

Type: Array of AdvancedEventSelector objects

CreatedTimestamp

The timestamp that shows when the event data store was created.

Type: Timestamp

EventDataStoreArn

The ARN of the event data store.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 256.

Pattern: ^[a-zA-Z0-9._/\-:]+$

KmsKeyId

Specifies the AWS KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a AWS KMS key in the following format.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

Type: String

Length Constraints: Minimum length of 1. Maximum length of 350.

Pattern: ^[a-zA-Z0-9._/\-:]+$

MultiRegionEnabled

Indicates whether the event data store collects events from all Regions, or only from the Region in which it was created.

Type: Boolean

Name

The name of the event data store.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^[a-zA-Z0-9._\-]+$

OrganizationEnabled

Indicates whether an event data store is collecting logged events for an organization in AWS Organizations.

Type: Boolean

RetentionPeriod

The retention period of an event data store, in days.

Type: Integer

Valid Range: Minimum value of 7. Maximum value of 2557.

Status

The status of event data store creation.

Type: String

Valid Values: CREATED | ENABLED | PENDING_DELETION | STARTING_INGESTION | STOPPING_INGESTION | STOPPED_INGESTION

TagsList

A list of tags.

Type: Array of Tag objects

Array Members: Maximum number of 200 items.

TerminationProtectionEnabled

Indicates whether termination protection is enabled for the event data store.

Type: Boolean

UpdatedTimestamp

The timestamp that shows when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

CloudTrailAccessNotEnabledException

This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS Organizations. For more information, see Enabling Trusted Access with Other AWS Services and Prepare For Creating a Trail For Your Organization.

HTTP Status Code: 400

ConflictException

This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.

HTTP Status Code: 400

EventDataStoreAlreadyExistsException

An event data store with that name already exists.

HTTP Status Code: 400

EventDataStoreMaxLimitExceededException

Your account has used the maximum number of event data stores.

HTTP Status Code: 400

InsufficientDependencyServiceAccessPermissionException

This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.

HTTP Status Code: 400

InsufficientEncryptionPolicyException

This exception is thrown when the policy on the S3 bucket or AWS KMS key does not have sufficient permissions for the operation.

HTTP Status Code: 400

InvalidEventSelectorsException

This exception is thrown when the PutEventSelectors operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.

You can:

  • Specify a valid number of event selectors (1 to 5) for a trail.

  • Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.

  • Specify up to 500 values for all conditions in all advanced event selectors for a trail.

  • Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is not valid.

HTTP Status Code: 400

InvalidKmsKeyIdException

This exception is thrown when the AWS KMS key ARN is not valid.

HTTP Status Code: 400

InvalidParameterException

The request includes a parameter that is not valid.

HTTP Status Code: 400

InvalidTagParameterException

This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.

HTTP Status Code: 400

KmsException

This exception is thrown when there is an issue with the specified AWS KMS key and the trail or event data store can't be updated.

HTTP Status Code: 400

KmsKeyNotFoundException

This exception is thrown when the AWS KMS key does not exist, when the S3 bucket and the AWS KMS key are not in the same Region, or when the AWS KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.

HTTP Status Code: 400

NoManagementAccountSLRExistsException

This exception is thrown when the management account does not have a service-linked role.

HTTP Status Code: 400

NotOrganizationMasterAccountException

This exception is thrown when the AWS account making the request to create or update an organization trail or event data store is not the management account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.

HTTP Status Code: 400

OperationNotPermittedException

This exception is thrown when the requested operation is not permitted.

HTTP Status Code: 400

OrganizationNotInAllFeaturesModeException

This exception is thrown when AWS Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.

HTTP Status Code: 400

OrganizationsNotInUseException

This exception is thrown when the request is made from an AWS account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.

HTTP Status Code: 400

UnsupportedOperationException

This exception is thrown when the requested operation is not supported.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: