class CfnEventDataStore (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.CloudTrail.CfnEventDataStore`
Java	`software.amazon.awscdk.services.cloudtrail.CfnEventDataStore`
Python	`aws_cdk.aws_cloudtrail.CfnEventDataStore`
TypeScript	`@aws-cdk/aws-cloudtrail` » `CfnEventDataStore`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::CloudTrail::EventDataStore.

Creates a new event data store.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudtrail from '@aws-cdk/aws-cloudtrail';
const cfnEventDataStore = new cloudtrail.CfnEventDataStore(this, 'MyCfnEventDataStore', /* all optional props */ {
  advancedEventSelectors: [{
    fieldSelectors: [{
      field: 'field',

      // the properties below are optional
      endsWith: ['endsWith'],
      equalTo: ['equalTo'],
      notEndsWith: ['notEndsWith'],
      notEquals: ['notEquals'],
      notStartsWith: ['notStartsWith'],
      startsWith: ['startsWith'],
    }],

    // the properties below are optional
    name: 'name',
  }],
  ingestionEnabled: false,
  kmsKeyId: 'kmsKeyId',
  multiRegionEnabled: false,
  name: 'name',
  organizationEnabled: false,
  retentionPeriod: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  terminationProtectionEnabled: false,
});

Initializer

new CfnEventDataStore(scope: Construct, id: string, props?: CfnEventDataStoreProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnEventDataStoreProps — - resource properties.

Create a new AWS::CloudTrail::EventDataStore.

Construct Props

Name	Type	Description
advancedEventSelectors?	`IResolvable` `\|` `IResolvable` `\|` `AdvancedEventSelectorProperty[]`	The advanced event selectors to use to select the events for the data store.
ingestionEnabled?	`boolean \|` `IResolvable`	Specifies whether the event data store should start ingesting live events.
kmsKeyId?	`string`	Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
multiRegionEnabled?	`boolean \|` `IResolvable`	Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.
name?	`string`	The name of the event data store.
organizationEnabled?	`boolean \|` `IResolvable`	Specifies whether an event data store collects events logged for an organization in AWS Organizations .
retentionPeriod?	`number`	The retention period of the event data store, in days.
tags?	`CfnTag[]`	A list of tags.
terminationProtectionEnabled?	`boolean \|` `IResolvable`	Specifies whether termination protection is enabled for the event data store.

advancedEventSelectors?

Type: IResolvable | IResolvable | AdvancedEventSelectorProperty[] (optional)

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

ingestionEnabled?

Type: boolean | IResolvable (optional)

Specifies whether the event data store should start ingesting live events.

The default is true.

kmsKeyId?

Type: string (optional)

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.

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

multiRegionEnabled?

Type: boolean | IResolvable (optional)

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

name?

Type: string (optional)

The name of the event data store.

organizationEnabled?

Type: boolean | IResolvable (optional)

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

retentionPeriod?

Type: number (optional)

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.

tags?

Type: CfnTag[] (optional)

A list of tags.

terminationProtectionEnabled?

Type: boolean | IResolvable (optional)

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.

Properties

Name	Type	Description
attrCreatedTimestamp	`string`	`Ref` returns the time stamp of the creation of the event data store, such as `1248496624` .
attrEventDataStoreArn	`string`	`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` .
attrStatus	`string`	`Ref` returns the status of the event data store, such as `ENABLED` .
attrUpdatedTimestamp	`string`	`Ref` returns the time stamp that updates were made to an event data store, such as `1598296624` .
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	A list of tags.
advancedEventSelectors?	`IResolvable` `\|` `IResolvable` `\|` `AdvancedEventSelectorProperty[]`	The advanced event selectors to use to select the events for the data store.
ingestionEnabled?	`boolean \|` `IResolvable`	Specifies whether the event data store should start ingesting live events.
kmsKeyId?	`string`	Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
multiRegionEnabled?	`boolean \|` `IResolvable`	Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.
name?	`string`	The name of the event data store.
organizationEnabled?	`boolean \|` `IResolvable`	Specifies whether an event data store collects events logged for an organization in AWS Organizations .
retentionPeriod?	`number`	The retention period of the event data store, in days.
terminationProtectionEnabled?	`boolean \|` `IResolvable`	Specifies whether termination protection is enabled for the event data store.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrCreatedTimestamp

Type: string

Ref returns the time stamp of the creation of the event data store, such as 1248496624 .

attrEventDataStoreArn

Type: string

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 .

attrStatus

Type: string

Ref returns the status of the event data store, such as ENABLED .

attrUpdatedTimestamp

Type: string

Ref returns the time stamp that updates were made to an event data store, such as 1598296624 .

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

advancedEventSelectors?

Type: IResolvable | IResolvable | AdvancedEventSelectorProperty[] (optional)

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.

ingestionEnabled?

Type: boolean | IResolvable (optional)

Specifies whether the event data store should start ingesting live events.

The default is true.

kmsKeyId?

Type: string (optional)

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.

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

multiRegionEnabled?

Type: boolean | IResolvable (optional)

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

name?

Type: string (optional)

The name of the event data store.

organizationEnabled?

Type: boolean | IResolvable (optional)

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

retentionPeriod?

Type: number (optional)

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?

Type: boolean | IResolvable (optional)

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }