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" } ], "MultiRegionEnabled": boolean, "Name": "string", "OrganizationEnabled": boolean, "RetentionPeriod": number, "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. For more information about how to use advanced event selectors, see Log events by using advanced event selectors in the CloudTrail User Guide.

Type: Array of AdvancedEventSelector objects

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 2555 days, the equivalent of seven years.

Type: Integer

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

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", "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._/\-:]+$

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

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. 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 user or role 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

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

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: