CloudTrail / Client / create_event_data_store
create_event_data_store#
- CloudTrail.Client.create_event_data_store(**kwargs)#
Creates a new event data store.
See also: AWS API Documentation
Request Syntax
response = client.create_event_data_store( Name='string', AdvancedEventSelectors=[ { 'Name': 'string', 'FieldSelectors': [ { 'Field': 'string', 'Equals': [ 'string', ], 'StartsWith': [ 'string', ], 'EndsWith': [ 'string', ], 'NotEquals': [ 'string', ], 'NotStartsWith': [ 'string', ], 'NotEndsWith': [ 'string', ] }, ] }, ], MultiRegionEnabled=True|False, OrganizationEnabled=True|False, RetentionPeriod=123, TerminationProtectionEnabled=True|False, TagsList=[ { 'Key': 'string', 'Value': 'string' }, ], KmsKeyId='string' )
- Parameters:
Name (string) –
[REQUIRED]
The name of the event data store.
AdvancedEventSelectors (list) –
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 Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.
For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.
(dict) –
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 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) – [REQUIRED]
Contains all selector statements in an advanced event selector.
(dict) –
A single selector statement in an advanced event selector.
Field (string) – [REQUIRED]
A field in a CloudTrail event record on which to filter events to be logged. For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.
For CloudTrail event records, supported fields include
readOnly
,eventCategory
,eventSource
(for management events),eventName
,resources.type
, andresources.ARN
.For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is
eventCategory
.readOnly
- Optional. Can be set toEquals
a value oftrue
orfalse
. If you do not add this field, CloudTrail logs bothread
andwrite
events. A value oftrue
logs onlyread
events. A value offalse
logs onlywrite
events.eventSource
- For filtering management events only. This can be set only toNotEquals
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 asPutBucket
orGetSnapshotBlock
. You can have multiple values for this field, separated by commas.eventCategory
- This is required and must be set toEquals
.For CloudTrail event records, the value must be
Management
orData
.For Config configuration items, the value must be
ConfigurationItem
.For Audit Manager evidence, the value must be
Evidence
.For non-Amazon Web Services events, the value must be
ActivityAuditLog
.
resources.type
- This field is required for CloudTrail data events.resources.type
can only use theEquals
operator, and the value can be one of the following:AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
AWS::CloudTrail::Channel
AWS::Cognito::IdentityPool
AWS::DynamoDB::Stream
AWS::EC2::Snapshot
AWS::FinSpace::Environment
AWS::Glue::Table
AWS::GuardDuty::Detector
AWS::KendraRanking::ExecutionPlan
AWS::ManagedBlockchain::Node
AWS::SageMaker::ExperimentTrialComponent
AWS::SageMaker::FeatureGroup
AWS::S3::AccessPoint
AWS::S3ObjectLambda::AccessPoint
AWS::S3Outposts::Object
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 withresources.ARN
, but if you useEquals
orNotEquals
, 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 equalsAWS::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 theStartsWith
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::DynamoDB::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals
AWS::Lambda::Function
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals
AWS::CloudTrail::Channel
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>
When resources.type equals
AWS::Cognito::IdentityPool
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_ID>
When
resources.type
equalsAWS::DynamoDB::Stream
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When
resources.type
equalsAWS::EC2::Snapshot
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When
resources.type
equalsAWS::FinSpace::Environment
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>
When
resources.type
equalsAWS::Glue::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
When
resources.type
equalsAWS::GuardDuty::Detector
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>
When
resources.type
equalsAWS::KendraRanking::ExecutionPlan
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>
When
resources.type
equalsAWS::ManagedBlockchain::Node
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When
resources.type
equalsAWS::SageMaker::ExperimentTrialComponent
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>
When
resources.type
equalsAWS::SageMaker::FeatureGroup
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>
When
resources.type
equalsAWS::S3::AccessPoint
, and the operator is set toEquals
orNotEquals
, 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 theStartsWith
orNotStartsWith
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
equalsAWS::S3ObjectLambda::AccessPoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When
resources.type
equalsAWS::S3Outposts::Object
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
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 thereadOnly
,eventCategory
, andresources.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) – Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
OrganizationEnabled (boolean) – Specifies whether an event data store collects events logged for an organization in Organizations.
RetentionPeriod (integer) – 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.
TerminationProtectionEnabled (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.
TagsList (list) –
A list of tags.
(dict) –
A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, or channel.
Key (string) – [REQUIRED]
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.
KmsKeyId (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
- Return type:
dict
- Returns:
Response Syntax
{ 'EventDataStoreArn': 'string', 'Name': 'string', 'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION', 'AdvancedEventSelectors': [ { 'Name': 'string', 'FieldSelectors': [ { 'Field': 'string', 'Equals': [ 'string', ], 'StartsWith': [ 'string', ], 'EndsWith': [ 'string', ], 'NotEquals': [ 'string', ], 'NotStartsWith': [ 'string', ], 'NotEndsWith': [ 'string', ] }, ] }, ], 'MultiRegionEnabled': True|False, 'OrganizationEnabled': True|False, 'RetentionPeriod': 123, 'TerminationProtectionEnabled': True|False, 'TagsList': [ { 'Key': 'string', 'Value': 'string' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'KmsKeyId': 'string' }
Response Structure
(dict) –
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.
(dict) –
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 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.
(dict) –
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 Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.
For CloudTrail event records, supported fields include
readOnly
,eventCategory
,eventSource
(for management events),eventName
,resources.type
, andresources.ARN
.For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is
eventCategory
.readOnly
- Optional. Can be set toEquals
a value oftrue
orfalse
. If you do not add this field, CloudTrail logs bothread
andwrite
events. A value oftrue
logs onlyread
events. A value offalse
logs onlywrite
events.eventSource
- For filtering management events only. This can be set only toNotEquals
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 asPutBucket
orGetSnapshotBlock
. You can have multiple values for this field, separated by commas.eventCategory
- This is required and must be set toEquals
.For CloudTrail event records, the value must be
Management
orData
.For Config configuration items, the value must be
ConfigurationItem
.For Audit Manager evidence, the value must be
Evidence
.For non-Amazon Web Services events, the value must be
ActivityAuditLog
.
resources.type
- This field is required for CloudTrail data events.resources.type
can only use theEquals
operator, and the value can be one of the following:AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
AWS::CloudTrail::Channel
AWS::Cognito::IdentityPool
AWS::DynamoDB::Stream
AWS::EC2::Snapshot
AWS::FinSpace::Environment
AWS::Glue::Table
AWS::GuardDuty::Detector
AWS::KendraRanking::ExecutionPlan
AWS::ManagedBlockchain::Node
AWS::SageMaker::ExperimentTrialComponent
AWS::SageMaker::FeatureGroup
AWS::S3::AccessPoint
AWS::S3ObjectLambda::AccessPoint
AWS::S3Outposts::Object
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 withresources.ARN
, but if you useEquals
orNotEquals
, 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 equalsAWS::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 theStartsWith
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::DynamoDB::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals
AWS::Lambda::Function
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals
AWS::CloudTrail::Channel
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>
When resources.type equals
AWS::Cognito::IdentityPool
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_ID>
When
resources.type
equalsAWS::DynamoDB::Stream
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When
resources.type
equalsAWS::EC2::Snapshot
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When
resources.type
equalsAWS::FinSpace::Environment
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>
When
resources.type
equalsAWS::Glue::Table
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
When
resources.type
equalsAWS::GuardDuty::Detector
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>
When
resources.type
equalsAWS::KendraRanking::ExecutionPlan
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>
When
resources.type
equalsAWS::ManagedBlockchain::Node
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When
resources.type
equalsAWS::SageMaker::ExperimentTrialComponent
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>
When
resources.type
equalsAWS::SageMaker::FeatureGroup
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>
When
resources.type
equalsAWS::S3::AccessPoint
, and the operator is set toEquals
orNotEquals
, 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 theStartsWith
orNotStartsWith
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
equalsAWS::S3ObjectLambda::AccessPoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When
resources.type
equalsAWS::S3Outposts::Object
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
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 thereadOnly
,eventCategory
, andresources.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.
(dict) –
A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, or channel.
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 (datetime) –
The timestamp that shows when the event data store was created.
UpdatedTimestamp (datetime) –
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 inCreatedTimestamp
.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
Exceptions
CloudTrail.Client.exceptions.EventDataStoreAlreadyExistsException
CloudTrail.Client.exceptions.EventDataStoreMaxLimitExceededException
CloudTrail.Client.exceptions.InvalidEventSelectorsException
CloudTrail.Client.exceptions.InvalidParameterException
CloudTrail.Client.exceptions.InvalidTagParameterException
CloudTrail.Client.exceptions.OperationNotPermittedException
CloudTrail.Client.exceptions.UnsupportedOperationException
CloudTrail.Client.exceptions.ConflictException
CloudTrail.Client.exceptions.InsufficientEncryptionPolicyException
CloudTrail.Client.exceptions.InvalidKmsKeyIdException
CloudTrail.Client.exceptions.KmsKeyNotFoundException
CloudTrail.Client.exceptions.KmsException
CloudTrail.Client.exceptions.CloudTrailAccessNotEnabledException
CloudTrail.Client.exceptions.InsufficientDependencyServiceAccessPermissionException
CloudTrail.Client.exceptions.NotOrganizationMasterAccountException
CloudTrail.Client.exceptions.OrganizationsNotInUseException
CloudTrail.Client.exceptions.OrganizationNotInAllFeaturesModeException
CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException