Package software.amazon.awscdk.mixins.preview.services.elasticache.mixins

Class CfnReplicationGroupPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.elasticache.mixins.CfnReplicationGroupPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnReplicationGroupPropsMixin>

Enclosing class:

CfnReplicationGroupPropsMixin

@Stability(Stable)
public static final class CfnReplicationGroupPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnReplicationGroupPropsMixin>

A fluent builder for CfnReplicationGroupPropsMixin.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnReplicationGroupPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnReplicationGroupPropsMixin.Builder.

create

@Stability(Stable)
public static CfnReplicationGroupPropsMixin.Builder create()

Returns:

a new instance of CfnReplicationGroupPropsMixin.Builder.

atRestEncryptionEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)

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

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

Parameters:

atRestEncryptionEnabled - A flag that enables encryption at rest when set to true . This parameter is required.

Returns:

this

See Also:

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

atRestEncryptionEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder atRestEncryptionEnabled(IResolvable atRestEncryptionEnabled)

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

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

Parameters:

atRestEncryptionEnabled - A flag that enables encryption at rest when set to true . This parameter is required.

Returns:

this

See Also:

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

authToken

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder authToken(String authToken)

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 .

Parameters:

authToken - Reserved parameter. The password used to access a password protected server. This parameter is required.

Returns:

this

See Also:

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

automaticFailoverEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder automaticFailoverEnabled(Boolean automaticFailoverEnabled)

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

Parameters:

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

Returns:

this

See Also:

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

automaticFailoverEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder automaticFailoverEnabled(IResolvable automaticFailoverEnabled)

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

Parameters:

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

Returns:

this

See Also:

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

autoMinorVersionUpgrade

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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.

Parameters:

autoMinorVersionUpgrade - 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. This parameter is required.

Returns:

this

See Also:

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

autoMinorVersionUpgrade

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)

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.

Parameters:

autoMinorVersionUpgrade - 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. This parameter is required.

Returns:

this

See Also:

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

cacheNodeType

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder cacheNodeType(String cacheNodeType)

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

Parameters:

cacheNodeType - The compute and memory capacity of the nodes in the node group (shard). This parameter is required.

Returns:

this

See Also:

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

cacheParameterGroupName

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder cacheParameterGroupName(String cacheParameterGroupName)

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 .

Parameters:

cacheParameterGroupName - The name of the parameter group to associate with this replication group. This parameter is required.

Returns:

this

See Also:

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

cacheSecurityGroupNames

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder cacheSecurityGroupNames(List<String> cacheSecurityGroupNames)

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

Parameters:

cacheSecurityGroupNames - A list of cache security group names to associate with this replication group. This parameter is required.

Returns:

this

See Also:

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

cacheSubnetGroupName

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder cacheSubnetGroupName(String cacheSubnetGroupName)

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 .

Parameters:

cacheSubnetGroupName - The name of the cache subnet group to be used for the replication group. This parameter is required.

Returns:

this

See Also:

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

clusterMode

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder clusterMode(String clusterMode)

The mode can be enabled or disabled.

To change the cluster mode from disabled to enabled, you must first set the cluster mode to compatible. The 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 .

Parameters:

clusterMode - The mode can be enabled or disabled. This parameter is required.

Returns:

this

See Also:

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

dataTieringEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder dataTieringEnabled(Boolean dataTieringEnabled)

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 .

Parameters:

dataTieringEnabled - Enables data tiering. This parameter is required.

Returns:

this

See Also:

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

dataTieringEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder dataTieringEnabled(IResolvable dataTieringEnabled)

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 .

Parameters:

dataTieringEnabled - Enables data tiering. This parameter is required.

Returns:

this

See Also:

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

engine

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder engine(String engine)

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.

Parameters:

engine - The name of the cache engine to be used for the clusters in this replication group. This parameter is required.

Returns:

this

See Also:

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

engineVersion

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder engineVersion(String engineVersion)

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.

Parameters:

engineVersion - The version number of the cache engine to be used for the clusters in this replication group. This parameter is required.

Returns:

this

See Also:

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

globalReplicationGroupId

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder globalReplicationGroupId(String globalReplicationGroupId)

The name of the Global datastore.

Parameters:

globalReplicationGroupId - The name of the Global datastore. This parameter is required.

Returns:

this

See Also:

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

ipDiscovery

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder ipDiscovery(String ipDiscovery)

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 .

Parameters:

ipDiscovery - The network type you choose when creating a replication group, either ipv4 | ipv6 . This parameter is required.

Returns:

this

See Also:

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

kmsKeyId

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

kmsKeyId - The ID of the KMS key used to encrypt the disk on the cluster. This parameter is required.

Returns:

this

See Also:

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

logDeliveryConfigurations

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder logDeliveryConfigurations(IResolvable logDeliveryConfigurations)

Specifies the destination, format and type of the logs.

Parameters:

logDeliveryConfigurations - Specifies the destination, format and type of the logs. This parameter is required.

Returns:

this

See Also:

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

logDeliveryConfigurations

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder logDeliveryConfigurations(List<? extends Object> logDeliveryConfigurations)

Specifies the destination, format and type of the logs.

Parameters:

logDeliveryConfigurations - Specifies the destination, format and type of the logs. This parameter is required.

Returns:

this

See Also:

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

multiAzEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder multiAzEnabled(Boolean multiAzEnabled)

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

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

Parameters:

multiAzEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. This parameter is required.

Returns:

this

See Also:

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

multiAzEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder multiAzEnabled(IResolvable multiAzEnabled)

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

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

Parameters:

multiAzEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. This parameter is required.

Returns:

this

See Also:

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

networkType

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder networkType(String networkType)

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 .

Parameters:

networkType - Must be either ipv4 | ipv6 | dual_stack . This parameter is required.

Returns:

this

See Also:

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

nodeGroupConfiguration

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder nodeGroupConfiguration(IResolvable nodeGroupConfiguration)

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 .

Parameters:

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

Returns:

this

See Also:

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

nodeGroupConfiguration

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder nodeGroupConfiguration(List<? extends Object> nodeGroupConfiguration)

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 .

Parameters:

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

Returns:

this

See Also:

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

notificationTopicArn

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder notificationTopicArn(String notificationTopicArn)

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.

Parameters:

notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. This parameter is required.

Returns:

this

See Also:

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

numCacheClusters

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder numCacheClusters(Number numCacheClusters)

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

Parameters:

numCacheClusters - The number of clusters this replication group initially has. This parameter is required.

Returns:

this

See Also:

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

numNodeGroups

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder numNodeGroups(Number numNodeGroups)

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

Parameters:

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

Returns:

this

See Also:

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

port

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder port(Number port)

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

Parameters:

port - The port number on which each member of the replication group accepts connections. This parameter is required.

Returns:

this

See Also:

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

preferredCacheClusterAZs

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder preferredCacheClusterAZs(List<String> preferredCacheClusterAZs)

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.

Parameters:

preferredCacheClusterAZs - A list of EC2 Availability Zones in which the replication group's clusters are created. This parameter is required.

Returns:

this

See Also:

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

preferredMaintenanceWindow

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

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

Parameters:

preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. This parameter is required.

Returns:

this

See Also:

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

primaryClusterId

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder primaryClusterId(String primaryClusterId)

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.

Parameters:

primaryClusterId - The identifier of the cluster that serves as the primary for this replication group. This parameter is required.

Returns:

this

See Also:

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

replicasPerNodeGroup

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder replicasPerNodeGroup(Number replicasPerNodeGroup)

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

Valid values are 0 to 5.

Parameters:

replicasPerNodeGroup - An optional parameter that specifies the number of replica nodes in each node group (shard). This parameter is required.

Returns:

this

See Also:

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

replicationGroupDescription

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder replicationGroupDescription(String replicationGroupDescription)

A user-created description for the replication group.

Parameters:

replicationGroupDescription - A user-created description for the replication group. This parameter is required.

Returns:

this

See Also:

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

replicationGroupId

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder replicationGroupId(String replicationGroupId)

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.

Parameters:

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

Returns:

this

See Also:

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

securityGroupIds

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder securityGroupIds(List<String> securityGroupIds)

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

Parameters:

securityGroupIds - One or more Amazon VPC security groups associated with this replication group. This parameter is required.

Returns:

this

See Also:

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

snapshotArns

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder snapshotArns(List<String> snapshotArns)

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

Parameters:

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

Returns:

this

See Also:

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

snapshotName

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder snapshotName(String snapshotName)

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.

Parameters:

snapshotName - The name of a snapshot from which to restore data into the new replication group. This parameter is required.

Returns:

this

See Also:

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

snapshotRetentionLimit

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder snapshotRetentionLimit(Number snapshotRetentionLimit)

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

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache retains automatic snapshots before deleting them. This parameter is required.

Returns:

this

See Also:

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

snapshottingClusterId

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder snapshottingClusterId(String snapshottingClusterId)

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.

Parameters:

snapshottingClusterId - The cluster ID that is used as the daily snapshot source for the replication group. This parameter is required.

Returns:

this

See Also:

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

snapshotWindow

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder snapshotWindow(String snapshotWindow)

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.

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - A list of tags to be added to this resource. This parameter is required.

Returns:

this

See Also:

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

transitEncryptionEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder transitEncryptionEnabled(Boolean transitEncryptionEnabled)

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

This parameter 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, 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 required when creating a new valkey replication group.

Default: false

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

Parameters:

transitEncryptionEnabled - A flag that enables in-transit encryption when set to true . This parameter is required.

Returns:

this

See Also:

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

transitEncryptionEnabled

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder transitEncryptionEnabled(IResolvable transitEncryptionEnabled)

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

This parameter 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, 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 required when creating a new valkey replication group.

Default: false

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

Parameters:

transitEncryptionEnabled - A flag that enables in-transit encryption when set to true . This parameter is required.

Returns:

this

See Also:

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

transitEncryptionMode

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder transitEncryptionMode(String transitEncryptionMode)

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.

Parameters:

transitEncryptionMode - A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. This parameter is required.

Returns:

this

See Also:

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

userGroupIds

@Stability(Stable)
public CfnReplicationGroupPropsMixin.Builder userGroupIds(List<String> userGroupIds)

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

Parameters:

userGroupIds - The ID of user group to associate with the replication group. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnReplicationGroupPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnReplicationGroupPropsMixin>

Returns:

a newly built instance of CfnReplicationGroupPropsMixin.