2.221.1

class CfnEventDataStore (construct)

LanguageType name
.NETAmazon.CDK.AWS.CloudTrail.CfnEventDataStore
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudtrail#CfnEventDataStore
Javasoftware.amazon.awscdk.services.cloudtrail.CfnEventDataStore
Pythonaws_cdk.aws_cloudtrail.CfnEventDataStore
TypeScript aws-cdk-lib » aws_cloudtrail » CfnEventDataStore

Implements IConstruct, IDependable, IInspectable, IEventDataStoreRef, ITaggable

Creates a new event data store.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudtrail as cloudtrail } from 'aws-cdk-lib';
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',
  }],
  billingMode: 'billingMode',
  contextKeySelectors: [{
    equalTo: ['equalTo'],
    type: 'type',
  }],
  federationEnabled: false,
  federationRoleArn: 'federationRoleArn',
  ingestionEnabled: false,
  insightsDestination: 'insightsDestination',
  insightSelectors: [{
    insightType: 'insightType',
  }],
  kmsKeyId: 'kmsKeyId',
  maxEventSize: 'maxEventSize',
  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 — Construct identifier for this resource (unique in its scope).
  • props CfnEventDataStoreProps — Resource properties.

Construct Props

NameTypeDescription
advancedEventSelectors?IResolvable | (IResolvable | AdvancedEventSelectorProperty)[]The advanced event selectors to use to select the events for the data store.
billingMode?stringThe 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.
contextKeySelectors?IResolvable | (IResolvable | ContextKeySelectorProperty)[]The list of context key selectors that are configured for the event data store.
federationEnabled?boolean | IResolvableIndicates 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.
federationRoleArn?stringIf Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.
ingestionEnabled?boolean | IResolvableSpecifies whether the event data store should start ingesting live events.
insightSelectors?IResolvable | (IResolvable | InsightSelectorProperty)[]A JSON string that contains the Insights types you want to log on an event data store.
insightsDestination?stringThe ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.
kmsKeyId?stringSpecifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
maxEventSize?stringThe maximum allowed size for events to be stored in the specified event data store.
multiRegionEnabled?boolean | IResolvableSpecifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.
name?stringThe name of the event data store.
organizationEnabled?boolean | IResolvableSpecifies whether an event data store collects events logged for an organization in AWS Organizations .
retentionPeriod?numberThe retention period of the event data store, in days.
tags?CfnTag[]A list of tags.
terminationProtectionEnabled?boolean | IResolvableSpecifies 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 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-advancedeventselectors

billingMode?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-billingmode

contextKeySelectors?

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

The list of context key selectors that are configured for the event data store.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-contextkeyselectors

federationEnabled?

Type: boolean | IResolvable (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationenabled

federationRoleArn?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationrolearn

ingestionEnabled?

Type: boolean | IResolvable (optional)

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

The default is true.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-ingestionenabled

insightSelectors?

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

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightselectors

insightsDestination?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightsdestination

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-kmskeyid

maxEventSize?

Type: string (optional)

The maximum allowed size for events to be stored in the specified event data store.

If you are using context key selectors, MaxEventSize must be set to Large.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-maxeventsize

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-multiregionenabled

name?

Type: string (optional)

The name of the event data store.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-name

organizationEnabled?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-organizationenabled

retentionPeriod?

Type: number (optional)

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.

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-retentionperiod

tags?

Type: CfnTag[] (optional)

A list of tags.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-terminationprotectionenabled

Properties

NameTypeDescription
attrCreatedTimestampstringRef returns the time stamp of the creation of the event data store, such as 1248496624 .
attrEventDataStoreArnstringRef returns the ARN of the CloudTrail event data store, such as arn:aws:cloudtrail:us-east-1:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE .
attrStatusstringRef returns the status of the event data store, such as ENABLED .
attrUpdatedTimestampstringRef returns the time stamp that updates were made to an event data store, such as 1598296624 .
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
eventDataStoreRefEventDataStoreReferenceA reference to a EventDataStore resource.
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerTag Manager which manages the tags for this resource.
advancedEventSelectors?IResolvable | (IResolvable | AdvancedEventSelectorProperty)[]The advanced event selectors to use to select the events for the data store.
billingMode?stringThe 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.
contextKeySelectors?IResolvable | (IResolvable | ContextKeySelectorProperty)[]The list of context key selectors that are configured for the event data store.
federationEnabled?boolean | IResolvableIndicates 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.
federationRoleArn?stringIf Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.
ingestionEnabled?boolean | IResolvableSpecifies whether the event data store should start ingesting live events.
insightSelectors?IResolvable | (IResolvable | InsightSelectorProperty)[]A JSON string that contains the Insights types you want to log on an event data store.
insightsDestination?stringThe ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.
kmsKeyId?stringSpecifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
maxEventSize?stringThe maximum allowed size for events to be stored in the specified event data store.
multiRegionEnabled?boolean | IResolvableSpecifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.
name?stringThe name of the event data store.
organizationEnabled?boolean | IResolvableSpecifies whether an event data store collects events logged for an organization in AWS Organizations .
retentionPeriod?numberThe retention period of the event data store, in days.
tagsRaw?CfnTag[]A list of tags.
terminationProtectionEnabled?boolean | IResolvableSpecifies whether termination protection is enabled for the event data store.
static CFN_RESOURCE_TYPE_NAMEstringThe 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[]

eventDataStoreRef

Type: EventDataStoreReference

A reference to a EventDataStore resource.

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: Node

The tree node.

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

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

advancedEventSelectors?

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

The advanced event selectors to use to select the events for the data store.

billingMode?

Type: string (optional)

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.

contextKeySelectors?

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

The list of context key selectors that are configured for the event data store.

federationEnabled?

Type: boolean | IResolvable (optional)

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.

federationRoleArn?

Type: string (optional)

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

ingestionEnabled?

Type: boolean | IResolvable (optional)

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

insightSelectors?

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

A JSON string that contains the Insights types you want to log on an event data store.

insightsDestination?

Type: string (optional)

The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.

kmsKeyId?

Type: string (optional)

Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.

maxEventSize?

Type: string (optional)

The maximum allowed size for events to be stored in the specified event data store.

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.

tagsRaw?

Type: CfnTag[] (optional)

A list of tags.

terminationProtectionEnabled?

Type: boolean | IResolvable (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
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, typeHint?)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.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
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).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

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.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

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

addMetadata(key, value)

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

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [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.](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

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

Returns

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.

See also: [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.](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.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

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

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): (Stack &#124; CfnResource)[]

Returns

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

Get a shallow copy of dependencies between this resource and other resources in the same stack.

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.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

Replaces one dependency with another.

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 }
← PreviousNext →