class CfnReplicationGroup (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ElastiCache.CfnReplicationGroup
Go	github.com/aws/aws-cdk-go/awscdk/v2/awselasticache#CfnReplicationGroup
Java	software.amazon.awscdk.services.elasticache.CfnReplicationGroup
Python	aws_cdk.aws_elasticache.CfnReplicationGroup
TypeScript	aws-cdk-lib » aws_elasticache » CfnReplicationGroup

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::ElastiCache::ReplicationGroup resource creates an Amazon ElastiCache (Valkey or Redis OSS) replication group.

A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of cache clusters, where one of the clusters is a primary read-write cluster and the others are read-only replicas.

A Valkey or Redis OSS (cluster mode enabled) cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.

The node or shard limit can be increased to a maximum of 500 per cluster if the engine version is Valkey 7.2 or higher, or Redis OSS 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group . For versions below 5.0.6, the limit is 250 per cluster.

To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticache as elasticache } from 'aws-cdk-lib';
const cfnReplicationGroup = new elasticache.CfnReplicationGroup(this, 'MyCfnReplicationGroup', {
  replicationGroupDescription: 'replicationGroupDescription',

  // the properties below are optional
  atRestEncryptionEnabled: false,
  authToken: 'authToken',
  automaticFailoverEnabled: false,
  autoMinorVersionUpgrade: false,
  cacheNodeType: 'cacheNodeType',
  cacheParameterGroupName: 'cacheParameterGroupName',
  cacheSecurityGroupNames: ['cacheSecurityGroupNames'],
  cacheSubnetGroupName: 'cacheSubnetGroupName',
  clusterMode: 'clusterMode',
  dataTieringEnabled: false,
  engine: 'engine',
  engineVersion: 'engineVersion',
  globalReplicationGroupId: 'globalReplicationGroupId',
  ipDiscovery: 'ipDiscovery',
  kmsKeyId: 'kmsKeyId',
  logDeliveryConfigurations: [{
    destinationDetails: {
      cloudWatchLogsDetails: {
        logGroup: 'logGroup',
      },
      kinesisFirehoseDetails: {
        deliveryStream: 'deliveryStream',
      },
    },
    destinationType: 'destinationType',
    logFormat: 'logFormat',
    logType: 'logType',
  }],
  multiAzEnabled: false,
  networkType: 'networkType',
  nodeGroupConfiguration: [{
    nodeGroupId: 'nodeGroupId',
    primaryAvailabilityZone: 'primaryAvailabilityZone',
    replicaAvailabilityZones: ['replicaAvailabilityZones'],
    replicaCount: 123,
    slots: 'slots',
  }],
  notificationTopicArn: 'notificationTopicArn',
  numCacheClusters: 123,
  numNodeGroups: 123,
  port: 123,
  preferredCacheClusterAZs: ['preferredCacheClusterAZs'],
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  primaryClusterId: 'primaryClusterId',
  replicasPerNodeGroup: 123,
  replicationGroupId: 'replicationGroupId',
  securityGroupIds: ['securityGroupIds'],
  snapshotArns: ['snapshotArns'],
  snapshotName: 'snapshotName',
  snapshotRetentionLimit: 123,
  snapshottingClusterId: 'snapshottingClusterId',
  snapshotWindow: 'snapshotWindow',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  transitEncryptionEnabled: false,
  transitEncryptionMode: 'transitEncryptionMode',
  userGroupIds: ['userGroupIds'],
});

Initializer

new CfnReplicationGroup(scope: Construct, id: string, props: CfnReplicationGroupProps)

Parameters

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

Construct Props

Name	Type	Description
replicationGroupDescription	string	A user-created description for the replication group.
atRestEncryptionEnabled?	boolean | IResolvable	A flag that enables encryption at rest when set to true .
authToken?	string	Reserved parameter. The password used to access a password protected server.
autoMinorVersionUpgrade?	boolean | IResolvable	If you are running Valkey 7.2 or later, or Redis OSS 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.
automaticFailoverEnabled?	boolean | IResolvable	Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
cacheNodeType?	string	The compute and memory capacity of the nodes in the node group (shard).
cacheParameterGroupName?	string	The name of the parameter group to associate with this replication group.
cacheSecurityGroupNames?	string[]	A list of cache security group names to associate with this replication group.
cacheSubnetGroupName?	string	The name of the cache subnet group to be used for the replication group.
clusterMode?	string	Enabled or Disabled.
dataTieringEnabled?	boolean | IResolvable	Enables data tiering.
engine?	string	The name of the cache engine to be used for the clusters in this replication group.
engineVersion?	string	The version number of the cache engine to be used for the clusters in this replication group.
globalReplicationGroupId?	string	The name of the Global datastore.
ipDiscovery?	string	The network type you choose when creating a replication group, either ipv4	ipv6 .
kmsKeyId?	string	The ID of the KMS key used to encrypt the disk on the cluster.
logDeliveryConfigurations?	IResolvable | IResolvable | LogDeliveryConfigurationRequestProperty[]	Specifies the destination, format and type of the logs.
multiAzEnabled?	boolean | IResolvable	A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
networkType?	string	Must be either ipv4	ipv6	dual_stack .
nodeGroupConfiguration?	IResolvable | IResolvable | NodeGroupConfigurationProperty[]	NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group.
notificationTopicArn?	string	The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
numCacheClusters?	number	The number of clusters this replication group initially has.
numNodeGroups?	number	An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group.
port?	number	The port number on which each member of the replication group accepts connections.
preferredCacheClusterAZs?	string[]	A list of EC2 Availability Zones in which the replication group's clusters are created.
preferredMaintenanceWindow?	string	Specifies the weekly time range during which maintenance on the cluster is performed.
primaryClusterId?	string	The identifier of the cluster that serves as the primary for this replication group.
replicasPerNodeGroup?	number	An optional parameter that specifies the number of replica nodes in each node group (shard).
replicationGroupId?	string	The replication group identifier. This parameter is stored as a lowercase string.
securityGroupIds?	string[]	One or more Amazon VPC security groups associated with this replication group.
snapshotArns?	string[]	A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3.
snapshotName?	string	The name of a snapshot from which to restore data into the new replication group.
snapshotRetentionLimit?	number	The number of days for which ElastiCache retains automatic snapshots before deleting them.
snapshotWindow?	string	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
snapshottingClusterId?	string	The cluster ID that is used as the daily snapshot source for the replication group.
tags?	CfnTag[]	A list of tags to be added to this resource.
transitEncryptionEnabled?	boolean | IResolvable	A flag that enables in-transit encryption when set to true .
transitEncryptionMode?	string	A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
userGroupIds?	string[]	The ID of user group to associate with the replication group.

---

replicationGroupDescription

Type: string

A user-created description for the replication group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupdescription

---

atRestEncryptionEnabled?

Type: boolean | IResolvable (optional)

A flag that enables encryption at rest when set to true .

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6 or 4.x onward.

Default: false

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-atrestencryptionenabled

---

authToken?

Type: string (optional)

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true . For more information, see Authenticating Valkey or Redis OSS users with the AUTH Command .

For HIPAA compliance, you must specify TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup .

Password constraints:

• Must be only printable ASCII characters.
• Must be at least 16 characters and no more than 128 characters in length.
• Nonalphanumeric characters are restricted to (!, &, #, $, ^, <, >, -, ).

For more information, see AUTH password at http://redis.io/commands/AUTH.

If ADDING the AuthToken, update requires Replacement .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-authtoken

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

If you are running Valkey 7.2 or later, or Redis OSS 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

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

---

automaticFailoverEnabled?

Type: boolean | IResolvable (optional)

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.

Default: false

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-automaticfailoverenabled

---

cacheNodeType?

Type: string (optional)

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

• General purpose:

• Current generation:

M6g node types: cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.12xlarge , cache.m6g.24xlarge

M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge

M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge

T4g node types: cache.t4g.micro , cache.t4g.small , cache.t4g.medium

T3 node types: cache.t3.micro , cache.t3.small , cache.t3.medium

T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium

• Previous generation: (not recommended)

T1 node types: cache.t1.micro

M1 node types: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge

M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge

• Compute optimized:

• Previous generation: (not recommended)

C1 node types: cache.c1.xlarge

• Memory optimized:

• Current generation:

R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge

The r6gd family is available in the following regions: us-east-2 , us-east-1 , us-west-2 , us-west-1 , eu-west-1 , eu-central-1 , ap-northeast-1 , ap-southeast-1 , ap-southeast-2 .

R6g node types: cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.12xlarge , cache.r6g.24xlarge

R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge

R4 node types: cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , cache.r4.8xlarge , cache.r4.16xlarge

• Previous generation: (not recommended)

M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge

R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge

For region availability, see Supported Node Types by Amazon Region

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachenodetype

---

cacheParameterGroupName?

Type: string (optional)

The name of the parameter group to associate with this replication group.

If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

• To create a Valkey or Redis OSS (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2 .
• To create a Valkey or Redis OSS (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cacheparametergroupname

---

cacheSecurityGroupNames?

Type: string[] (optional)

A list of cache security group names to associate with this replication group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesecuritygroupnames

---

cacheSubnetGroupName?

Type: string (optional)

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see AWS::ElastiCache::SubnetGroup .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesubnetgroupname

---

clusterMode?

Type: string (optional)

Enabled or Disabled.

To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-clustermode

---

dataTieringEnabled?

Type: boolean | IResolvable (optional)

Enables data tiering.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-datatieringenabled

---

engine?

Type: string (optional)

The name of the cache engine to be used for the clusters in this replication group.

The value must be set to valkey or redis .

Upgrading an existing engine from redis to valkey is done through in-place migration, and requires a parameter group.

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

---

engineVersion?

Type: string (optional)

The version number of the cache engine to be used for the clusters in this replication group.

To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ) in the ElastiCache User Guide , but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

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

---

globalReplicationGroupId?

Type: string (optional)

The name of the Global datastore.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-globalreplicationgroupid

---

ipDiscovery?

Type: string (optional)

The network type you choose when creating a replication group, either ipv4 | ipv6 .

IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-ipdiscovery

---

kmsKeyId?

Type: string (optional)

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

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

---

logDeliveryConfigurations?

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

Specifies the destination, format and type of the logs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-logdeliveryconfigurations

---

multiAzEnabled?

Type: boolean | IResolvable (optional)

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.

For more information, see Minimizing Downtime: Multi-AZ .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-multiazenabled

---

networkType?

Type: string (optional)

Must be either ipv4 | ipv6 | dual_stack .

IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-networktype

---

nodeGroupConfiguration?

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

NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group.

If you set UseOnlineResharding to true , you can update NodeGroupConfiguration without interruption. When UseOnlineResharding is set to false , or is not specified, updating NodeGroupConfiguration results in replacement .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-nodegroupconfiguration

---

notificationTopicArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-notificationtopicarn

---

numCacheClusters?

Type: number (optional)

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true , the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numcacheclusters

---

numNodeGroups?

Type: number (optional)

An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group.

For Valkey or Redis OSS (cluster mode disabled) either omit this parameter or set it to 1.

If you set UseOnlineResharding to true , you can update NumNodeGroups without interruption. When UseOnlineResharding is set to false , or is not specified, updating NumNodeGroups results in replacement .

Default: 1

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numnodegroups

---

port?

Type: number (optional)

The port number on which each member of the replication group accepts connections.

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

---

preferredCacheClusterAZs?

Type: string[] (optional)

A list of EC2 Availability Zones in which the replication group's clusters are created.

The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters .

Default: system chosen Availability Zones.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredcacheclusterazs

---

preferredMaintenanceWindow?

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.

Valid values for ddd are:

• sun
• mon
• tue
• wed
• thu
• fri
• sat

Example: sun:23:00-mon:01:30

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredmaintenancewindow

---

primaryClusterId?

Type: string (optional)

The identifier of the cluster that serves as the primary for this replication group.

This cluster must already exist and have a status of available .

This parameter is not required if NumCacheClusters , NumNodeGroups , or ReplicasPerNodeGroup is specified.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-primaryclusterid

---

replicasPerNodeGroup?

Type: number (optional)

An optional parameter that specifies the number of replica nodes in each node group (shard).

Valid values are 0 to 5.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicaspernodegroup

---

replicationGroupId?

Type: string (optional)

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

• A name must contain from 1 to 40 alphanumeric characters or hyphens.
• The first character must be a letter.
• A name cannot end with a hyphen or contain two consecutive hyphens.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupid

---

securityGroupIds?

Type: string[] (optional)

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

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

---

snapshotArns?

Type: string[] (optional)

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

The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

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

---

snapshotName?

Type: string (optional)

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

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

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

---

snapshotRetentionLimit?

Type: number (optional)

The number of days for which ElastiCache 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.

Default: 0 (i.e., automatic backups are disabled for this cluster).

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

---

snapshotWindow?

Type: string (optional)

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

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

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

---

snapshottingClusterId?

Type: string (optional)

The cluster ID that is used as the daily snapshot source for the replication group.

This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshottingclusterid

---

tags?

Type: CfnTag[] (optional)

A list of tags to be added to this resource.

Tags are comma-separated key,value pairs (e.g. Key= myKey , Value= myKeyValue . You can include multiple tags as shown following: Key= myKey , Value= myKeyValue Key= mySecondKey , Value= mySecondKeyValue . Tags on replication groups will be replicated to all nodes.

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

---

transitEncryptionEnabled?

Type: boolean | IResolvable (optional)

A flag that enables in-transit encryption when set to true .

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

This parameter is valid only if the Engine parameter is redis , the EngineVersion parameter is 3.2.6 or 4.x onward, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup .

• TransitEncryptionEnabled is only available when creating a replication group in an Amazon VPC using Valkey version 7.2 and above, Redis OSS version 3.2.6 , or Redis OSS version 4.x and above.
• TransitEncryptionEnabled is required when creating a new valkey replication group.

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionenabled

---

transitEncryptionMode?

Type: string (optional)

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

When setting TransitEncryptionEnabled to true , you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to required to allow encrypted connections only.

Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred , after that you can set TransitEncryptionMode to required .

This process will not trigger the replacement of the replication group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionmode

---

userGroupIds?

Type: string[] (optional)

The ID of user group to associate with the replication group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-usergroupids

Properties

Name	Type	Description
attrConfigurationEndPointAddress	string	The DNS hostname of the cache node.
attrConfigurationEndPointPort	string	The port number that the cache engine is listening on.
attrPrimaryEndPointAddress	string	The DNS address of the primary read-write cache node.
attrPrimaryEndPointPort	string	The number of the port that the primary read-write cache engine is listening on.
attrReadEndPointAddresses	string	A string with a list of endpoints for the primary and read-only replicas.
attrReadEndPointAddressesList	string[]	A string with a list of endpoints for the read-only replicas.
attrReadEndPointPorts	string	A string with a list of ports for the read-only replicas.
attrReadEndPointPortsList	string[]	A string with a list of ports for the read-only replicas.
attrReaderEndPointAddress	string	The address of the reader endpoint.
attrReaderEndPointPort	string	The port used by the reader endpoint.
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	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
replicationGroupDescription	string	A user-created description for the replication group.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
atRestEncryptionEnabled?	boolean | IResolvable	A flag that enables encryption at rest when set to true .
authToken?	string	Reserved parameter. The password used to access a password protected server.
autoMinorVersionUpgrade?	boolean | IResolvable	If you are running Valkey 7.2 or later, or Redis OSS 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.
automaticFailoverEnabled?	boolean | IResolvable	Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
cacheNodeType?	string	The compute and memory capacity of the nodes in the node group (shard).
cacheParameterGroupName?	string	The name of the parameter group to associate with this replication group.
cacheSecurityGroupNames?	string[]	A list of cache security group names to associate with this replication group.
cacheSubnetGroupName?	string	The name of the cache subnet group to be used for the replication group.
clusterMode?	string	Enabled or Disabled.
dataTieringEnabled?	boolean | IResolvable	Enables data tiering.
engine?	string	The name of the cache engine to be used for the clusters in this replication group.
engineVersion?	string	The version number of the cache engine to be used for the clusters in this replication group.
globalReplicationGroupId?	string	The name of the Global datastore.
ipDiscovery?	string	The network type you choose when creating a replication group, either ipv4	ipv6 .
kmsKeyId?	string	The ID of the KMS key used to encrypt the disk on the cluster.
logDeliveryConfigurations?	IResolvable | IResolvable | LogDeliveryConfigurationRequestProperty[]	Specifies the destination, format and type of the logs.
multiAzEnabled?	boolean | IResolvable	A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
networkType?	string	Must be either ipv4	ipv6	dual_stack .
nodeGroupConfiguration?	IResolvable | IResolvable | NodeGroupConfigurationProperty[]	NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group.
notificationTopicArn?	string	The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
numCacheClusters?	number	The number of clusters this replication group initially has.
numNodeGroups?	number	An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group.
port?	number	The port number on which each member of the replication group accepts connections.
preferredCacheClusterAZs?	string[]	A list of EC2 Availability Zones in which the replication group's clusters are created.
preferredMaintenanceWindow?	string	Specifies the weekly time range during which maintenance on the cluster is performed.
primaryClusterId?	string	The identifier of the cluster that serves as the primary for this replication group.
replicasPerNodeGroup?	number	An optional parameter that specifies the number of replica nodes in each node group (shard).
replicationGroupId?	string	The replication group identifier.
securityGroupIds?	string[]	One or more Amazon VPC security groups associated with this replication group.
snapshotArns?	string[]	A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3.
snapshotName?	string	The name of a snapshot from which to restore data into the new replication group.
snapshotRetentionLimit?	number	The number of days for which ElastiCache retains automatic snapshots before deleting them.
snapshotWindow?	string	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
snapshottingClusterId?	string	The cluster ID that is used as the daily snapshot source for the replication group.
tagsRaw?	CfnTag[]	A list of tags to be added to this resource.
transitEncryptionEnabled?	boolean | IResolvable	A flag that enables in-transit encryption when set to true .
transitEncryptionMode?	string	A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
userGroupIds?	string[]	The ID of user group to associate with the replication group.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrConfigurationEndPointAddress

Type: string

The DNS hostname of the cache node.

Valkey or Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, Fn::GetAtt returns a value for this attribute only if the replication group is clustered. Otherwise, Fn::GetAtt fails. For Valkey or Redis OSS (cluster mode disabled) replication groups, use the PrimaryEndpoint or ReadEndpoint attributes.

---

attrConfigurationEndPointPort

Type: string

The port number that the cache engine is listening on.

---

attrPrimaryEndPointAddress

Type: string

The DNS address of the primary read-write cache node.

---

attrPrimaryEndPointPort

Type: string

The number of the port that the primary read-write cache engine is listening on.

---

attrReadEndPointAddresses

Type: string

A string with a list of endpoints for the primary and read-only replicas.

The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.

---

attrReadEndPointAddressesList

Type: string[]

A string with a list of endpoints for the read-only replicas.

The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.

---

attrReadEndPointPorts

Type: string

A string with a list of ports for the read-only replicas.

The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.

---

attrReadEndPointPortsList

Type: string[]

A string with a list of ports for the read-only replicas.

The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.

---

attrReaderEndPointAddress

Type: string

The address of the reader endpoint.

---

attrReaderEndPointPort

Type: string

The port used by the reader endpoint.

---

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

---

replicationGroupDescription

Type: string

A user-created description for the replication group.

---

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.

---

atRestEncryptionEnabled?

Type: boolean | IResolvable (optional)

A flag that enables encryption at rest when set to true .

---

authToken?

Type: string (optional)

Reserved parameter. The password used to access a password protected server.

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

If you are running Valkey 7.2 or later, or Redis OSS 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

---

automaticFailoverEnabled?

Type: boolean | IResolvable (optional)

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

---

cacheNodeType?

Type: string (optional)

The compute and memory capacity of the nodes in the node group (shard).

---

cacheParameterGroupName?

Type: string (optional)

The name of the parameter group to associate with this replication group.

---

cacheSecurityGroupNames?

Type: string[] (optional)

A list of cache security group names to associate with this replication group.

---

cacheSubnetGroupName?

Type: string (optional)

The name of the cache subnet group to be used for the replication group.

---

clusterMode?

Type: string (optional)

Enabled or Disabled.

---

dataTieringEnabled?

Type: boolean | IResolvable (optional)

Enables data tiering.

---

engine?

Type: string (optional)

The name of the cache engine to be used for the clusters in this replication group.

---

engineVersion?

Type: string (optional)

The version number of the cache engine to be used for the clusters in this replication group.

---

globalReplicationGroupId?

Type: string (optional)

The name of the Global datastore.

---

ipDiscovery?

Type: string (optional)

The network type you choose when creating a replication group, either ipv4 | ipv6 .

---

kmsKeyId?

Type: string (optional)

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

---

logDeliveryConfigurations?

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

Specifies the destination, format and type of the logs.

---

multiAzEnabled?

Type: boolean | IResolvable (optional)

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.

---

networkType?

Type: string (optional)

Must be either ipv4 | ipv6 | dual_stack .

---

nodeGroupConfiguration?

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

NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group.

---

notificationTopicArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

---

numCacheClusters?

Type: number (optional)

The number of clusters this replication group initially has.

---

numNodeGroups?

Type: number (optional)

An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group.

---

port?

Type: number (optional)

The port number on which each member of the replication group accepts connections.

---

preferredCacheClusterAZs?

Type: string[] (optional)

A list of EC2 Availability Zones in which the replication group's clusters are created.

---

preferredMaintenanceWindow?

Type: string (optional)

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

---

primaryClusterId?

Type: string (optional)

The identifier of the cluster that serves as the primary for this replication group.

---

replicasPerNodeGroup?

Type: number (optional)

An optional parameter that specifies the number of replica nodes in each node group (shard).

---

replicationGroupId?

Type: string (optional)

The replication group identifier.

This parameter is stored as a lowercase string.

---

securityGroupIds?

Type: string[] (optional)

One or more Amazon VPC security groups associated with this replication group.

---

snapshotArns?

Type: string[] (optional)

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

---

snapshotName?

Type: string (optional)

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

---

snapshotRetentionLimit?

Type: number (optional)

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

---

snapshotWindow?

Type: string (optional)

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

---

snapshottingClusterId?

Type: string (optional)

The cluster ID that is used as the daily snapshot source for the replication group.

---

tagsRaw?

Type: CfnTag[] (optional)

A list of tags to be added to this resource.

---

transitEncryptionEnabled?

Type: boolean | IResolvable (optional)

A flag that enables in-transit encryption when set to true .

---

transitEncryptionMode?

Type: string (optional)

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

---

userGroupIds?

Type: string[] (optional)

The ID of user group to associate with the replication group.

---

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 }