class CfnCluster (construct)

Language	Type name
.NET	Amazon.CDK.AWS.MemoryDB.CfnCluster
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsmemorydb#CfnCluster
Java	software.amazon.awscdk.services.memorydb.CfnCluster
Python	aws_cdk.aws_memorydb.CfnCluster
TypeScript	aws-cdk-lib » aws_memorydb » CfnCluster

Implements IConstruct, IDependable, IInspectable, ITaggable

Specifies a cluster .

All nodes in the cluster run the same protocol-compliant engine software.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_memorydb as memorydb } from 'aws-cdk-lib';
const cfnCluster = new memorydb.CfnCluster(this, 'MyCfnCluster', {
  aclName: 'aclName',
  clusterName: 'clusterName',
  nodeType: 'nodeType',

  // the properties below are optional
  autoMinorVersionUpgrade: false,
  clusterEndpoint: {
    address: 'address',
    port: 123,
  },
  dataTiering: 'dataTiering',
  description: 'description',
  engine: 'engine',
  engineVersion: 'engineVersion',
  finalSnapshotName: 'finalSnapshotName',
  kmsKeyId: 'kmsKeyId',
  maintenanceWindow: 'maintenanceWindow',
  multiRegionClusterName: 'multiRegionClusterName',
  numReplicasPerShard: 123,
  numShards: 123,
  parameterGroupName: 'parameterGroupName',
  port: 123,
  securityGroupIds: ['securityGroupIds'],
  snapshotArns: ['snapshotArns'],
  snapshotName: 'snapshotName',
  snapshotRetentionLimit: 123,
  snapshotWindow: 'snapshotWindow',
  snsTopicArn: 'snsTopicArn',
  snsTopicStatus: 'snsTopicStatus',
  subnetGroupName: 'subnetGroupName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tlsEnabled: false,
});

Initializer

new CfnCluster(scope: Construct, id: string, props: CfnClusterProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnClusterProps — Resource properties.

Construct Props

Name	Type	Description
aclName	string	The name of the Access Control List to associate with the cluster .
clusterName	string	The name of the cluster .
nodeType	string	The cluster 's node type.
autoMinorVersionUpgrade?	boolean | IResolvable	When set to true, the cluster will automatically receive minor engine version upgrades after launch.
clusterEndpoint?	IResolvable | EndpointProperty	The cluster 's configuration endpoint.
dataTiering?	string	Enables data tiering.
description?	string	A description of the cluster .
engine?	string	The name of the engine used by the cluster.
engineVersion?	string	The Valkey or Redis OSS engine version used by the cluster .
finalSnapshotName?	string	The user-supplied name of a final cluster snapshot.
kmsKeyId?	string	The ID of the KMS key used to encrypt the cluster .
maintenanceWindow?	string	Specifies the weekly time range during which maintenance on the cluster is performed.
multiRegionClusterName?	string	The name of the multi-Region cluster that this cluster belongs to.
numReplicasPerShard?	number	The number of replicas to apply to each shard.
numShards?	number	The number of shards in the cluster .
parameterGroupName?	string	The name of the parameter group used by the cluster .
port?	number	The port used by the cluster .
securityGroupIds?	string[]	A list of security group names to associate with this cluster .
snapshotArns?	string[]	A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
snapshotName?	string	The name of a snapshot from which to restore data into the new cluster .
snapshotRetentionLimit?	number	The number of days for which MemoryDB retains automatic snapshots before deleting them.
snapshotWindow?	string	The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
snsTopicArn?	string	When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic.
snsTopicStatus?	string	The SNS topic must be in Active status to receive notifications.
subnetGroupName?	string	The name of the subnet group used by the cluster .
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.
tlsEnabled?	boolean | IResolvable	A flag to indicate if In-transit encryption is enabled.

---

aclName

Type: string

The name of the Access Control List to associate with the cluster .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-aclname

---

clusterName

Type: string

The name of the cluster .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clustername

---

nodeType

Type: string

The cluster 's node type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-nodetype

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-autominorversionupgrade

---

clusterEndpoint?

Type: IResolvable | EndpointProperty (optional)

The cluster 's configuration endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clusterendpoint

---

dataTiering?

Type: string (optional)

Enables data tiering.

Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-datatiering

---

description?

Type: string (optional)

A description of the cluster .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-description

---

engine?

Type: string (optional)

The name of the engine used by the cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-engine

---

engineVersion?

Type: string (optional)

The Valkey or Redis OSS engine version used by the cluster .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-engineversion

---

finalSnapshotName?

Type: string (optional)

The user-supplied name of a final cluster snapshot.

This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-finalsnapshotname

---

kmsKeyId?

Type: string (optional)

The ID of the KMS key used to encrypt the cluster .

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

---

maintenanceWindow?

Type: string (optional)

Specifies the weekly time range during which maintenance on the cluster is performed.

It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Pattern : ddd:hh24:mi-ddd:hh24:mi

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-maintenancewindow

---

multiRegionClusterName?

Type: string (optional)

The name of the multi-Region cluster that this cluster belongs to.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-multiregionclustername

---

numReplicasPerShard?

Type: number (optional)

The number of replicas to apply to each shard.

Default value : 1

Maximum value : 5

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numreplicaspershard

---

numShards?

Type: number (optional)

The number of shards in the cluster .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numshards

---

parameterGroupName?

Type: string (optional)

The name of the parameter group used by the cluster .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-parametergroupname

---

port?

Type: number (optional)

The port used by the cluster .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-port

---

securityGroupIds?

Type: string[] (optional)

A list of security group names to associate with this cluster .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-securitygroupids

---

snapshotArns?

Type: string[] (optional)

A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.

The snapshot files are used to populate the new cluster . The Amazon S3 object name in the ARN cannot contain any commas.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotarns

---

snapshotName?

Type: string (optional)

The name of a snapshot from which to restore data into the new cluster .

The snapshot status changes to restoring while the new cluster is being created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotname

---

snapshotRetentionLimit?

Type: number (optional)

The number of days for which MemoryDB retains automatic snapshots before deleting them.

For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotretentionlimit

---

snapshotWindow?

Type: string (optional)

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotwindow

---

snsTopicArn?

Type: string (optional)

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicarn

---

snsTopicStatus?

Type: string (optional)

The SNS topic must be in Active status to receive notifications.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicstatus

---

subnetGroupName?

Type: string (optional)

The name of the subnet group used by the cluster .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-subnetgroupname

---

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tags

---

tlsEnabled?

Type: boolean | IResolvable (optional)

A flag to indicate if In-transit encryption is enabled.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tlsenabled

Properties

Name	Type	Description
aclName	string	The name of the Access Control List to associate with the cluster .
attrArn	string	When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the cluster , such as arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster.
attrClusterEndpointAddress	string	The address of the cluster 's configuration endpoint.
attrClusterEndpointPort	number	The port used by the cluster configuration endpoint.
attrParameterGroupStatus	string	The status of the parameter group used by the cluster , for example active or applying .
attrStatus	string	The status of the cluster.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
clusterName	string	The name of the cluster .
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
nodeType	string	The cluster 's node type.
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	Tag Manager which manages the tags for this resource.
autoMinorVersionUpgrade?	boolean | IResolvable	When set to true, the cluster will automatically receive minor engine version upgrades after launch.
clusterEndpoint?	IResolvable | EndpointProperty	The cluster 's configuration endpoint.
dataTiering?	string	Enables data tiering.
description?	string	A description of the cluster .
engine?	string	The name of the engine used by the cluster.
engineVersion?	string	The Valkey or Redis OSS engine version used by the cluster .
finalSnapshotName?	string	The user-supplied name of a final cluster snapshot.
kmsKeyId?	string	The ID of the KMS key used to encrypt the cluster .
maintenanceWindow?	string	Specifies the weekly time range during which maintenance on the cluster is performed.
multiRegionClusterName?	string	The name of the multi-Region cluster that this cluster belongs to.
numReplicasPerShard?	number	The number of replicas to apply to each shard.
numShards?	number	The number of shards in the cluster .
parameterGroupName?	string	The name of the parameter group used by the cluster .
port?	number	The port used by the cluster .
securityGroupIds?	string[]	A list of security group names to associate with this cluster .
snapshotArns?	string[]	A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
snapshotName?	string	The name of a snapshot from which to restore data into the new cluster .
snapshotRetentionLimit?	number	The number of days for which MemoryDB retains automatic snapshots before deleting them.
snapshotWindow?	string	The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
snsTopicArn?	string	When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic.
snsTopicStatus?	string	The SNS topic must be in Active status to receive notifications.
subnetGroupName?	string	The name of the subnet group used by the cluster .
tagsRaw?	CfnTag[]	An array of key-value pairs to apply to this resource.
tlsEnabled?	boolean | IResolvable	A flag to indicate if In-transit encryption is enabled.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

aclName

Type: string

The name of the Access Control List to associate with the cluster .

---

attrArn

Type: string

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the cluster , such as arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster.

---

attrClusterEndpointAddress

Type: string

The address of the cluster 's configuration endpoint.

---

attrClusterEndpointPort

Type: number

The port used by the cluster configuration endpoint.

---

attrParameterGroupStatus

Type: string

The status of the parameter group used by the cluster , for example active or applying .

---

attrStatus

Type: string

The status of the cluster.

For example, 'available', 'updating' or 'creating'.

---

cfnOptions

Type: ICfnResourceOptions

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

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

clusterName

Type: string

The name of the cluster .

---

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

The tree node.

---

nodeType

Type: string

The cluster 's node type.

---

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.

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

---

clusterEndpoint?

Type: IResolvable | EndpointProperty (optional)

The cluster 's configuration endpoint.

---

dataTiering?

Type: string (optional)

Enables data tiering.

---

description?

Type: string (optional)

A description of the cluster .

---

engine?

Type: string (optional)

The name of the engine used by the cluster.

---

engineVersion?

Type: string (optional)

The Valkey or Redis OSS engine version used by the cluster .

---

finalSnapshotName?

Type: string (optional)

The user-supplied name of a final cluster snapshot.

---

kmsKeyId?

Type: string (optional)

The ID of the KMS key used to encrypt the cluster .

---

maintenanceWindow?

Type: string (optional)

Specifies the weekly time range during which maintenance on the cluster is performed.

---

multiRegionClusterName?

Type: string (optional)

The name of the multi-Region cluster that this cluster belongs to.

---

numReplicasPerShard?

Type: number (optional)

The number of replicas to apply to each shard.

---

numShards?

Type: number (optional)

The number of shards in the cluster .

---

parameterGroupName?

Type: string (optional)

The name of the parameter group used by the cluster .

---

port?

Type: number (optional)

The port used by the cluster .

---

securityGroupIds?

Type: string[] (optional)

A list of security group names to associate with this cluster .

---

snapshotArns?

Type: string[] (optional)

A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.

---

snapshotName?

Type: string (optional)

The name of a snapshot from which to restore data into the new cluster .

---

snapshotRetentionLimit?

Type: number (optional)

The number of days for which MemoryDB retains automatic snapshots before deleting them.

---

snapshotWindow?

Type: string (optional)

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

---

snsTopicArn?

Type: string (optional)

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic.

---

snsTopicStatus?

Type: string (optional)

The SNS topic must be in Active status to receive notifications.

---

subnetGroupName?

Type: string (optional)

The name of the subnet group used by the cluster .

---

tagsRaw?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

---

tlsEnabled?

Type: boolean | IResolvable (optional)

A flag to indicate if In-transit encryption is enabled.

---

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

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

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

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

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

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

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.

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 | CfnResource[]

Returns

• Stack | CfnResource[]

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

• CfnResource[]

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

• target CfnResource

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

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

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 }