AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudtrail ]

update-event-data-store

Description

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 7 and 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING , or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING . By default, TerminationProtection is enabled.

For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management, data, or network activity events in your event data store. For more information about AdvancedEventSelectors , see AdvancedEventSelectors .

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, AdvancedEventSelectors includes events of that type in your event data store.

See also: AWS API Documentation

Synopsis

  update-event-data-store
--event-data-store <value>
[--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]
[--kms-key-id <value>]
[--billing-mode <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--event-data-store (string)

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

--name (string)

The event data store name.

--advanced-event-selectors (list)

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

(structure)

Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events , Logging network activity events , and Logging management events topics in the CloudTrail User Guide .

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

Supported CloudTrail event record fields for management events
  • eventCategory (required)
  • eventSource
  • readOnly

The following additional fields are available for event data stores:

  • eventName
  • eventType
  • sessionCredentialFromConsole
  • userIdentity.arn
Supported CloudTrail event record fields for data events
  • eventCategory (required)
  • resources.type (required)
  • readOnly
  • eventName
  • resources.ARN

The following additional fields are available for event data stores:

  • eventSource
  • eventType
  • sessionCredentialFromConsole
  • userIdentity.arn
Supported CloudTrail event record fields for network activity events

Note

Network activity events is in preview release for CloudTrail and is subject to change.
  • eventCategory (required)
  • eventSource (required)
  • eventName
  • errorCode - The only valid value for errorCode is VpceAccessDenied .
  • vpcEndpointId

Note

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory .

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 a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.

For CloudTrail management events, supported fields include eventCategory (required), eventSource , and readOnly . The following additional fields are available for event data stores: eventName , eventType , sessionCredentialFromConsole , and userIdentity.arn .

For CloudTrail data events, supported fields include eventCategory (required), resources.type (required), eventName , readOnly , and resources.ARN . The following additional fields are available for event data stores: eventSource , eventType , sessionCredentialFromConsole , and userIdentity.arn .

For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName , errorCode , and vpcEndpointId .

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory .

  • **readOnly ** - This is an optional field that is only used for management events and data events. This field can be set to Equals with a value of true or false . If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events.
  • **eventSource ** - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events:
    • cloudtrail.amazonaws.com
    • ec2.amazonaws.com
    • kms.amazonaws.com
    • secretsmanager.amazonaws.com
  • **eventName ** - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with eventName . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas.
  • **eventCategory ** - This field is required and must be set to Equals .
    • For CloudTrail management events, the value must be Management .
    • For CloudTrail data events, the value must be Data .
    • For CloudTrail network activity events, the value must be NetworkActivity .

The following are used only for event data stores:

  • For CloudTrail Insights events, the value must be Insight .
  • For Config configuration items, the value must be ConfigurationItem .
  • For Audit Manager evidence, the value must be Evidence .
  • For events outside of Amazon Web Services, the value must be ActivityAuditLog .
  • **eventType ** - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see CloudTrail record contents in the CloudTrail user guide .
  • **errorCode ** - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied . errorCode can only use the Equals operator.
  • **sessionCredentialFromConsole ** - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an Amazon Web Services Management Console session. sessionCredentialFromConsole can only use the Equals and NotEquals operators.
  • **resources.type ** - This field is required for CloudTrail data events. resources.type can only use the Equals operator. For a list of available resource types for data events, see Data events in the CloudTrail User Guide . You can have only one resources.type field per selector. To log events on more than one resource type, add another selector.
  • **resources.ARN ** - The resources.ARN is an optional field for data events. 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. 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. For information about filtering data events on the resources.ARN field, see Filtering data events by resources.ARN in the CloudTrail User Guide .

Note

You can't use the resources.ARN field to filter resource types that do not have ARNs.
  • **userIdentity.arn ** - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with userIdentity.arn . For more information on the userIdentity element, see CloudTrail userIdentity element in the CloudTrail User Guide .
  • **vpcEndpointId ** - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId .

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 an event data store collects events from all Regions, or only from the Region in which it was created.

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

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

Note

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

--retention-period (integer)

The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING , you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING , 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 decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

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

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

--kms-key-id (string)

Specifies the 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.

Warning

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 KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the 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

--billing-mode (string)

Note

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING . If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING .

The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

The following are the possible values:

  • EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.
  • FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs .

Possible values:

  • EXTENDABLE_RETENTION_PRICING
  • FIXED_RETENTION_PRICING

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

EventDataStoreArn -> (string)

The ARN of the event data store.

Name -> (string)

The name of the event data store.

Status -> (string)

The status of an event data store.

AdvancedEventSelectors -> (list)

The advanced event selectors that are applied to the event data store.

(structure)

Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events , Logging network activity events , and Logging management events topics in the CloudTrail User Guide .

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

Supported CloudTrail event record fields for management events
  • eventCategory (required)
  • eventSource
  • readOnly

The following additional fields are available for event data stores:

  • eventName
  • eventType
  • sessionCredentialFromConsole
  • userIdentity.arn
Supported CloudTrail event record fields for data events
  • eventCategory (required)
  • resources.type (required)
  • readOnly
  • eventName
  • resources.ARN

The following additional fields are available for event data stores:

  • eventSource
  • eventType
  • sessionCredentialFromConsole
  • userIdentity.arn
Supported CloudTrail event record fields for network activity events

Note

Network activity events is in preview release for CloudTrail and is subject to change.
  • eventCategory (required)
  • eventSource (required)
  • eventName
  • errorCode - The only valid value for errorCode is VpceAccessDenied .
  • vpcEndpointId

Note

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory .

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 a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.

For CloudTrail management events, supported fields include eventCategory (required), eventSource , and readOnly . The following additional fields are available for event data stores: eventName , eventType , sessionCredentialFromConsole , and userIdentity.arn .

For CloudTrail data events, supported fields include eventCategory (required), resources.type (required), eventName , readOnly , and resources.ARN . The following additional fields are available for event data stores: eventSource , eventType , sessionCredentialFromConsole , and userIdentity.arn .

For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName , errorCode , and vpcEndpointId .

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory .

  • **readOnly ** - This is an optional field that is only used for management events and data events. This field can be set to Equals with a value of true or false . If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events.
  • **eventSource ** - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events:
    • cloudtrail.amazonaws.com
    • ec2.amazonaws.com
    • kms.amazonaws.com
    • secretsmanager.amazonaws.com
  • **eventName ** - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with eventName . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas.
  • **eventCategory ** - This field is required and must be set to Equals .
    • For CloudTrail management events, the value must be Management .
    • For CloudTrail data events, the value must be Data .
    • For CloudTrail network activity events, the value must be NetworkActivity .

The following are used only for event data stores:

  • For CloudTrail Insights events, the value must be Insight .
  • For Config configuration items, the value must be ConfigurationItem .
  • For Audit Manager evidence, the value must be Evidence .
  • For events outside of Amazon Web Services, the value must be ActivityAuditLog .
  • **eventType ** - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see CloudTrail record contents in the CloudTrail user guide .
  • **errorCode ** - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied . errorCode can only use the Equals operator.
  • **sessionCredentialFromConsole ** - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an Amazon Web Services Management Console session. sessionCredentialFromConsole can only use the Equals and NotEquals operators.
  • **resources.type ** - This field is required for CloudTrail data events. resources.type can only use the Equals operator. For a list of available resource types for data events, see Data events in the CloudTrail User Guide . You can have only one resources.type field per selector. To log events on more than one resource type, add another selector.
  • **resources.ARN ** - The resources.ARN is an optional field for data events. 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. 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. For information about filtering data events on the resources.ARN field, see Filtering data events by resources.ARN in the CloudTrail User Guide .

Note

You can't use the resources.ARN field to filter resource types that do not have ARNs.
  • **userIdentity.arn ** - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with userIdentity.arn . For more information on the userIdentity element, see CloudTrail userIdentity element in the CloudTrail User Guide .
  • **vpcEndpointId ** - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId .

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 includes 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, in days.

TerminationProtectionEnabled -> (boolean)

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

CreatedTimestamp -> (timestamp)

The timestamp that shows when an event data store was first created.

UpdatedTimestamp -> (timestamp)

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

KmsKeyId -> (string)

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

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

BillingMode -> (string)

The billing mode for the event data store.

FederationStatus -> (string)

Indicates the Lake query federation status. The status is ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED .

FederationRoleArn -> (string)

If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.