AWS CLI Command Reference

[ aws . cloudtrail ]

create-event-data-store

Description

Creates a new event data store.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-event-data-store
--name <value>
[--advanced-event-selectors <value>]
[--multi-region-enabled | --no-multi-region-enabled]
[--organization-enabled | --no-organization-enabled]
[--retention-period <value>]
[--termination-protection-enabled | --no-termination-protection-enabled]
[--tags-list <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the event data store.

--advanced-event-selectors (list)

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.

(structure)

Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

  • readOnly

  • eventSource

  • eventName

  • eventCategory

  • resources.type

  • resources.ARN

You cannot apply both event selectors and advanced event selectors to a trail.

Name -> (string)

An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.

FieldSelectors -> (list)

Contains all selector statements in an advanced event selector.

(structure)

A single selector statement in an advanced event selector.

Field -> (string)

A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

  • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.

  • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .

  • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.

  • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .

  • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:

    • AWS::S3::Object

    • AWS::Lambda::Function

    • AWS::DynamoDB::Table

    • AWS::S3Outposts::Object

    • AWS::ManagedBlockchain::Node

    • AWS::S3ObjectLambda::AccessPoint

    • AWS::EC2::Snapshot

    • AWS::S3::AccessPoint

    • AWS::DynamoDB::Stream

    • AWS::Glue::Table

You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

  • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you’ve specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.

    • arn:<partition>:s3:::<bucket_name>/

    • arn:<partition>:s3:::<bucket_name>/<object_path>/

When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

  • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>

  • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>

Equals -> (list)

An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

(string)

StartsWith -> (list)

An operator that includes events that match the first few characters of the event record field specified as the value of Field .

(string)

EndsWith -> (list)

An operator that includes events that match the last few characters of the event record field specified as the value of Field .

(string)

NotEquals -> (list)

An operator that excludes events that match the exact value of the event record field specified as the value of Field .

(string)

NotStartsWith -> (list)

An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

(string)

NotEndsWith -> (list)

An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

(string)

JSON Syntax:

[
  {
    "Name": "string",
    "FieldSelectors": [
      {
        "Field": "string",
        "Equals": ["string", ...],
        "StartsWith": ["string", ...],
        "EndsWith": ["string", ...],
        "NotEquals": ["string", ...],
        "NotStartsWith": ["string", ...],
        "NotEndsWith": ["string", ...]
      }
      ...
    ]
  }
  ...
]

--multi-region-enabled | --no-multi-region-enabled (boolean)

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

--organization-enabled | --no-organization-enabled (boolean)

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

--retention-period (integer)

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.

--termination-protection-enabled | --no-termination-protection-enabled (boolean)

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.

--tags-list (list)

A list of tags.

(structure)

A custom key-value pair associated with a resource such as a CloudTrail trail.

Key -> (string)

The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

Value -> (string)

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

EventDataStoreArn -> (string)

The ARN of the event data store.

Name -> (string)

The name of the event data store.

Status -> (string)

The status of event data store creation.

AdvancedEventSelectors -> (list)

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

(structure)

Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide .

  • readOnly

  • eventSource

  • eventName

  • eventCategory

  • resources.type

  • resources.ARN

You cannot apply both event selectors and advanced event selectors to a trail.

Name -> (string)

An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.

FieldSelectors -> (list)

Contains all selector statements in an advanced event selector.

(structure)

A single selector statement in an advanced event selector.

Field -> (string)

A field in an event record on which to filter events to be logged. Supported fields include readOnly , eventCategory , eventSource (for management events), eventName , resources.type , and resources.ARN .

  • **readOnly ** - Optional. Can be set to Equals a value of true or false . If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.

  • **eventSource ** - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com .

  • **eventName ** - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . You can have multiple values for this field, separated by commas.

  • **eventCategory ** - This is required. It must be set to Equals , and the value must be Management or Data .

  • **resources.type ** - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:

    • AWS::S3::Object

    • AWS::Lambda::Function

    • AWS::DynamoDB::Table

    • AWS::S3Outposts::Object

    • AWS::ManagedBlockchain::Node

    • AWS::S3ObjectLambda::AccessPoint

    • AWS::EC2::Snapshot

    • AWS::S3::AccessPoint

    • AWS::DynamoDB::Stream

    • AWS::Glue::Table

You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

  • **resources.ARN ** - You can use any operator with resources.ARN , but if you use Equals or NotEquals , the value must exactly match the ARN of a valid resource of the type you’ve specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object , the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.

    • arn:<partition>:s3:::<bucket_name>/

    • arn:<partition>:s3:::<bucket_name>/<object_path>/

When resources.type equals AWS::S3::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

  • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>

  • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

When resources.type equals AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

When resources.type equals AWS::DynamoDB::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

When resources.type equals AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

When resources.type equals AWS::ManagedBlockchain::Node , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

When resources.type equals AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

When resources.type equals AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

When resources.type equals AWS::DynamoDB::Stream , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

When resources.type equals AWS::Glue::Table , and the operator is set to Equals or NotEquals , the ARN must be in the following format:

  • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>

Equals -> (list)

An operator that includes events that match the exact value of the event record field specified as the value of Field . This is the only valid operator that you can use with the readOnly , eventCategory , and resources.type fields.

(string)

StartsWith -> (list)

An operator that includes events that match the first few characters of the event record field specified as the value of Field .

(string)

EndsWith -> (list)

An operator that includes events that match the last few characters of the event record field specified as the value of Field .

(string)

NotEquals -> (list)

An operator that excludes events that match the exact value of the event record field specified as the value of Field .

(string)

NotStartsWith -> (list)

An operator that excludes events that match the first few characters of the event record field specified as the value of Field .

(string)

NotEndsWith -> (list)

An operator that excludes events that match the last few characters of the event record field specified as the value of Field .

(string)

MultiRegionEnabled -> (boolean)

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

OrganizationEnabled -> (boolean)

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

RetentionPeriod -> (integer)

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

TerminationProtectionEnabled -> (boolean)

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

TagsList -> (list)

A list of tags.

(structure)

A custom key-value pair associated with a resource such as a CloudTrail trail.

Key -> (string)

The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

Value -> (string)

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

CreatedTimestamp -> (timestamp)

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

UpdatedTimestamp -> (timestamp)

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 .

© Copyright 2018, Amazon Web Services. Created using Sphinx.