AWS::CloudTrail::EventDataStore - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::CloudTrail::EventDataStore

Creates a new event data store.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CloudTrail::EventDataStore",
  "Properties" : {
      "AdvancedEventSelectors" : [ AdvancedEventSelector, ... ],
      "BillingMode" : String,
      "FederationEnabled" : Boolean,
      "FederationRoleArn" : String,
      "IngestionEnabled" : Boolean,
      "InsightsDestination" : String,
      "InsightSelectors" : [ InsightSelector, ... ],
      "KmsKeyId" : String,
      "MultiRegionEnabled" : Boolean,
      "Name" : String,
      "OrganizationEnabled" : Boolean,
      "RetentionPeriod" : Integer,
      "Tags" : [ Tag, ... ],
      "TerminationProtectionEnabled" : Boolean
    }
}

YAML

Type: AWS::CloudTrail::EventDataStore
Properties:
  AdvancedEventSelectors: 
    - AdvancedEventSelector
  BillingMode: String
  FederationEnabled: Boolean
  FederationRoleArn: String
  IngestionEnabled: Boolean
  InsightsDestination: String
  InsightSelectors: 
    - InsightSelector
  KmsKeyId: String
  MultiRegionEnabled: Boolean
  Name: String
  OrganizationEnabled: Boolean
  RetentionPeriod: Integer
  Tags: 
    - Tag
  TerminationProtectionEnabled: Boolean

Properties

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 events outside of AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

Required: No

Type: Array of AdvancedEventSelector

Update requires: No interruption

BillingMode

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.

The default value is EXTENDABLE_RETENTION_PRICING.

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

Required: No

Type: String

Allowed values: EXTENDABLE_RETENTION_PRICING | FIXED_RETENTION_PRICING

Update requires: No interruption

FederationEnabled

Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.

Required: No

Type: Boolean

Update requires: No interruption

FederationRoleArn

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

The federation role must exist in your account and provide the required minimum permissions.

Required: No

Type: String

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

Minimum: 3

Maximum: 125

Update requires: No interruption

IngestionEnabled

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

Required: No

Type: Boolean

Update requires: No interruption

InsightsDestination

The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. For more information, see Create an event data store for CloudTrail Insights events.

Required: No

Type: String

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

Minimum: 3

Maximum: 256

Update requires: No interruption

InsightSelectors

A JSON string that contains the Insights types you want to log on an event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.

The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.

Required: No

Type: Array of InsightSelector

Update requires: No interruption

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

Required: No

Type: String

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

Minimum: 1

Maximum: 350

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

Name

The name of the event data store.

Required: No

Type: String

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

Minimum: 3

Maximum: 128

Update requires: No interruption

OrganizationEnabled

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

Required: No

Type: Boolean

Update requires: No interruption

RetentionPeriod

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

Required: No

Type: Integer

Minimum: 7

Maximum: 3653

Update requires: No interruption

Tags

A list of tags.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedTimestamp

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the time stamp of the creation of the event data store, such as 1248496624.

EventDataStoreArn

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the CloudTrail event data store, such as arn:aws:cloudtrail:us-east-1:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE.

Status

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the status of the event data store, such as ENABLED.

UpdatedTimestamp

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the time stamp that updates were made to an event data store, such as 1598296624.

Examples

Example: Create an event data store for management events

The following example creates an event data store that logs management events in all Regions. For information about creating an event data store for management events, see Create an event data store for CloudTrail events in the AWS CloudTrail User Guide.

In this example, FederationEnabled is set to true to enable Lake query federation and FederationRoleArn is set to the ARN of the federation role used to access the federated resources. The federation role must exist in your account and provide the required minimum permissions.

JSON

{
    "Parameters": {
        "Name": {
            "Type": "String"
        }
    },
    "Conditions": {
        "IsOrganizationsSupported": {
            "Fn::Not": [
                {
                    "Fn::Equals": [
                        {
                            "Ref": "AWS::Partition"
                        },
                        "aws-cn"
                    ]
                }
            ]
        }
    },
    "Resources": {
        "myEventDataStore": {
            "Type": "AWS::CloudTrail::EventDataStore",
            "Properties": {
                "Name": {
                    "Ref": "Name"
                },
                "MultiRegionEnabled": true,
                "IngestionEnabled": true,
                "FederationEnabled": true,
                "FederationRoleArn": "arn:aws:iam::account-id:role/federation-role-name",
                "BillingMode": "EXTENDABLE_RETENTION_PRICING",
                "RetentionPeriod": 366,
                "OrganizationEnabled": {
                    "Fn::If": [
                        "IsOrganizationsSupported",
                        true,
                        {
                            "Ref": "AWS::NoValue"
                        }
                    ]
                },
                "TerminationProtectionEnabled": false,
                "KmsKeyId": {
                    "Fn::ImportValue": "EventDataStoreKeyTest"
                },
                "Tags": [
                    {
                        "Key": "TagKeyIntTest",
                        "Value": "TagValueIntTest"
                    },
                    {
                        "Key": "TagKeyIntTest2",
                        "Value": "TagValueIntTest2"
                    }
                ],
                "AdvancedEventSelectors": [
                    {
                        "Name": "AdvancedEventSelectors1",
                        "FieldSelectors": [
                            {
                                "Field": "eventCategory",
                                "Equals": [
                                    "Management"
                                ]
                            }
                        ]
                    }
                ]
            }
        }
    },
    "Outputs": {
        "myEventDataStoreArn": {
            "Description": "The event data store ARN",
            "Value": {
                "Fn::GetAtt": [
                    "myEventDataStore",
                    "EventDataStoreArn"
                ]
            }
        }
    }
}

YAML

Parameters:
  Name:
    Type: String
Conditions:
  IsOrganizationsSupported:
    !Not [!Equals [Ref: "AWS::Partition", "aws-cn"]]
Resources:
  myEventDataStore:
    Type: AWS::CloudTrail::EventDataStore
    Properties:
      Name: !Ref Name
      MultiRegionEnabled: true
      IngestionEnabled: true
      FederationEnabled: true
      FederationRoleArn: "arn:aws:iam::account-id:role/federation-role-name"
      BillingMode: "EXTENDABLE_RETENTION_PRICING"
      RetentionPeriod: 366
      OrganizationEnabled:
        Fn::If:
          - IsOrganizationsSupported
          - true
          - !Ref "AWS::NoValue"
      TerminationProtectionEnabled: false
      KmsKeyId:
        Fn::ImportValue: EventDataStoreKeyTest
      Tags:
        - Key: "TagKeyIntTest"
          Value: "TagValueIntTest"
        - Key: "TagKeyIntTest2"
          Value: "TagValueIntTest2"
      AdvancedEventSelectors:
        - Name: "AdvancedEventSelectors1"
          FieldSelectors:
          - Field: "eventCategory"
            Equals: [ "Management" ]
Outputs:
  myEventDataStoreArn:
    Description: The eventdatastore ARN
    Value:
      'Fn::GetAtt':
        - myEventDataStore
        - EventDataStoreArn

Example: Create a destination event data store to collect Insights events

The following example creates a destination event data store that collects Insights on unusual management event activity in the source event data store. For information about creating event data stores for CloudTrail Insights, see Create an event data store for CloudTrail Insights events in the AWS CloudTrail User Guide.

JSON

{
    "Parameters": {
        "Name": {
            "Type": "String"
        }
    },
    "Conditions": {
        "IsOrganizationsSupported": {
            "Fn::Not": [
                {
                    "Fn::Equals": [
                        {
                            "Ref": "AWS::Partition"
                        },
                        "aws-cn"
                    ]
                }
            ]
        }
    },
    "Resources": {
        "myEventDataStore": {
            "Type": "AWS::CloudTrail::EventDataStore",
            "Properties": {
                "Name": {
                    "Ref": "Name"
                },
                "MultiRegionEnabled": false,
                "IngestionEnabled": true,
                "BillingMode": "EXTENDABLE_RETENTION_PRICING",
                "RetentionPeriod": 90,
                "OrganizationEnabled": {
                    "Fn::If": [
                        "IsOrganizationsSupported",
                        true,
                        {
                            "Ref": "AWS::NoValue"
                        }
                    ]
                },
                "TerminationProtectionEnabled": false,
                "KmsKeyId": {
                    "Fn::ImportValue": "EventDataStoreKeyTest"
                },
                "Tags": [
                    {
                        "Key": "TagKeyIntTest",
                        "Value": "TagValueIntTest"
                    },
                    {
                        "Key": "TagKeyIntTest2",
                        "Value": "TagValueIntTest2"
                    }
                ],
                "AdvancedEventSelectors": [
                    {
                        "Name": "AdvancedEventSelectors1",
                        "FieldSelectors": [
                            {
                                "Field": "eventCategory",
                                "Equals": [
                                    "Insight"
                                ]
                            }
                        ]
                    }
                ]
            }
        }
    },
    "Outputs": {
        "myEventDataStoreArn": {
            "Description": "The event data store ARN",
            "Value": {
                "Fn::GetAtt": [
                    "myEventDataStore",
                    "EventDataStoreArn"
                ]
            }
        }
    }
}

YAML

Parameters:
  Name:
    Type: String
Conditions:
  IsOrganizationsSupported:
    !Not [!Equals [Ref: "AWS::Partition", "aws-cn"]]
Resources:
  myEventDataStore:
    Type: AWS::CloudTrail::EventDataStore
    Properties:
      Name: !Ref Name
      MultiRegionEnabled: false
      IngestionEnabled: true
      BillingMode: "EXTENDABLE_RETENTION_PRICING"
      RetentionPeriod: 90
      OrganizationEnabled:
        Fn::If:
          - IsOrganizationsSupported
          - true
          - !Ref "AWS::NoValue"
      TerminationProtectionEnabled: false
      KmsKeyId:
        Fn::ImportValue: EventDataStoreKeyTest
      Tags:
        - Key: "TagKeyIntTest"
          Value: "TagValueIntTest"
        - Key: "TagKeyIntTest2"
          Value: "TagValueIntTest2"
      AdvancedEventSelectors:
        - Name: "AdvancedEventSelectors1"
          FieldSelectors:
          - Field: "eventCategory"
            Equals: [ "Insight" ]
Outputs:
  myEventDataStoreArn:
    Description: The eventdatastore ARN
    Value:
      'Fn::GetAtt':
        - myEventDataStore
        - EventDataStoreArn

Example: Create a source event data store that enables Insights events

The following example creates a source event data store that logs management events and enables Insights. Specify the ARN (or ID suffix of the ARN) of the destination event data store created in the preceding example as the value of the InsighsDestination parameter. For information about creating event data stores for CloudTrail Insights, see Create an event data store for CloudTrail Insights events in the AWS CloudTrail User Guide.

JSON

{
    "Parameters": {
        "Name": {
            "Type": "String"
        }
    },
    "Conditions": {
        "IsOrganizationsSupported": {
            "Fn::Not": [
                {
                    "Fn::Equals": [
                        {
                            "Ref": "AWS::Partition"
                        },
                        "aws-cn"
                    ]
                }
            ]
        }
    },
    "Resources": {
        "myEventDataStore": {
            "Type": "AWS::CloudTrail::EventDataStore",
            "Properties": {
                "Name": {
                    "Ref": "Name"
                },
                "MultiRegionEnabled": true,
                "IngestionEnabled": true,
                "BillingMode": "EXTENDABLE_RETENTION_PRICING",
                "RetentionPeriod": 90,
                "OrganizationEnabled": {
                    "Fn::If": [
                        "IsOrganizationsSupported",
                        true,
                        {
                            "Ref": "AWS::NoValue"
                        }
                    ]
                },
                "TerminationProtectionEnabled": false,
                "KmsKeyId": {
                    "Fn::ImportValue": "EventDataStoreKeyTest"
                },
                "Tags": [
                    {
                        "Key": "TagKeyIntTest",
                        "Value": "TagValueIntTest"
                    },
                    {
                        "Key": "TagKeyIntTest2",
                        "Value": "TagValueIntTest2"
                    }
                ],
                "InsightsDestination": "DestinationEventDataStoreArn",
                "InsightSelectors": [
                  {
                        "InsightType": "ApiCallRateInsight"
                  },
                  {
                        "InsightType": "ApiErrorRateInsight"
                  }
               ],
                "AdvancedEventSelectors": [
                    {
                        "Name": "AdvancedEventSelectors1",
                        "FieldSelectors": [
                            {
                                "Field": "eventCategory",
                                "Equals": [
                                    "Management"
                                ]
                            }
                        ]
                    }
                ]
            }
        }
    },
    "Outputs": {
        "myEventDataStoreArn": {
            "Description": "The event data store ARN",
            "Value": {
                "Fn::GetAtt": [
                    "myEventDataStore",
                    "EventDataStoreArn"
                ]
            }
        }
    }
}

YAML

Parameters:
  Name:
    Type: String
Conditions:
  IsOrganizationsSupported:
    !Not [!Equals [Ref: "AWS::Partition", "aws-cn"]]
Resources:
  myEventDataStore:
    Type: AWS::CloudTrail::EventDataStore
    Properties:
      Name: !Ref Name
      MultiRegionEnabled: true
      IngestionEnabled: true
      BillingMode: "EXTENDABLE_RETENTION_PRICING"
      RetentionPeriod: 90
      OrganizationEnabled:
        Fn::If:
          - IsOrganizationsSupported
          - true
          - !Ref "AWS::NoValue"
      TerminationProtectionEnabled: false
      KmsKeyId:
        Fn::ImportValue: EventDataStoreKeyTest
      Tags:
        - Key: "TagKeyIntTest"
          Value: "TagValueIntTest"
        - Key: "TagKeyIntTest2"
          Value: "TagValueIntTest2"
      InsightsDestination: DestinationEventDataStoreArn
      InsightSelectors:
         - InsightType: "ApiCallRateInsight"
         - InsightType: "ApiErrorRateInsight"
      AdvancedEventSelectors:
        - Name: "AdvancedEventSelectors1"
          FieldSelectors:
          - Field: "eventCategory"
            Equals: [ "Management" ]
Outputs:
  myEventDataStoreArn:
    Description: The eventdatastore ARN
    Value:
      'Fn::GetAtt':
        - myEventDataStore
        - EventDataStoreArn