Package software.amazon.awscdk.services.elasticache

Class CfnReplicationGroupProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.elasticache.CfnReplicationGroupProps.Jsii$Proxy

All Implemented Interfaces:

CfnReplicationGroupProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnReplicationGroupProps

@Stability(Stable)
@Internal
public static final class CfnReplicationGroupProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnReplicationGroupProps

An implementation for CfnReplicationGroupProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticache.CfnReplicationGroupProps

CfnReplicationGroupProps.Builder, CfnReplicationGroupProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnReplicationGroupProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnReplicationGroupProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAtRestEncryptionEnabled()	A flag that enables encryption at rest when set to true .
final String	getAuthToken()	Reserved parameter. The password used to access a password protected server.
final Object	getAutomaticFailoverEnabled()	Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
final Object	getAutoMinorVersionUpgrade()	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.
final String	getCacheNodeType()	The compute and memory capacity of the nodes in the node group (shard).
final String	getCacheParameterGroupName()	The name of the parameter group to associate with this replication group.
final List<String>	getCacheSecurityGroupNames()	A list of cache security group names to associate with this replication group.
final String	getCacheSubnetGroupName()	The name of the cache subnet group to be used for the replication group.
final String	getClusterMode()	Enabled or Disabled.
final Object	getDataTieringEnabled()	Enables data tiering.
final String	getEngine()	The name of the cache engine to be used for the clusters in this replication group.
final String	getEngineVersion()	The version number of the cache engine to be used for the clusters in this replication group.
final String	getGlobalReplicationGroupId()	The name of the Global datastore.
final String	getIpDiscovery()	The network type you choose when creating a replication group, either ipv4 | ipv6 .
final String	getKmsKeyId()	The ID of the KMS key used to encrypt the disk on the cluster.
final Object	getLogDeliveryConfigurations()	Specifies the destination, format and type of the logs.
final Object	getMultiAzEnabled()	A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
final String	getNetworkType()	Must be either ipv4 | ipv6 | dual_stack .
final Object	getNodeGroupConfiguration()	NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group.
final String	getNotificationTopicArn()	The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
final Number	getNumCacheClusters()	The number of clusters this replication group initially has.
final Number	getNumNodeGroups()	An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group.
final Number	getPort()	The port number on which each member of the replication group accepts connections.
final List<String>	getPreferredCacheClusterAZs()	A list of EC2 Availability Zones in which the replication group's clusters are created.
final String	getPreferredMaintenanceWindow()	Specifies the weekly time range during which maintenance on the cluster is performed.
final String	getPrimaryClusterId()	The identifier of the cluster that serves as the primary for this replication group.
final Number	getReplicasPerNodeGroup()	An optional parameter that specifies the number of replica nodes in each node group (shard).
final String	getReplicationGroupDescription()	A user-created description for the replication group.
final String	getReplicationGroupId()	The replication group identifier.
final List<String>	getSecurityGroupIds()	One or more Amazon VPC security groups associated with this replication group.
final List<String>	getSnapshotArns()	A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3.
final String	getSnapshotName()	The name of a snapshot from which to restore data into the new replication group.
final Number	getSnapshotRetentionLimit()	The number of days for which ElastiCache retains automatic snapshots before deleting them.
final String	getSnapshottingClusterId()	The cluster ID that is used as the daily snapshot source for the replication group.
final String	getSnapshotWindow()	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
final List<CfnTag>	getTags()	A list of tags to be added to this resource.
final Object	getTransitEncryptionEnabled()	A flag that enables in-transit encryption when set to true .
final String	getTransitEncryptionMode()	A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
final List<String>	getUserGroupIds()	The ID of user group to associate with the replication group.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnReplicationGroupProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnReplicationGroupProps.Builder.

Method Details

getReplicationGroupDescription

public final String getReplicationGroupDescription()

Description copied from interface: CfnReplicationGroupProps

A user-created description for the replication group.

Specified by:

getReplicationGroupDescription in interface CfnReplicationGroupProps

See Also:

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

getAtRestEncryptionEnabled

public final Object getAtRestEncryptionEnabled()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getAtRestEncryptionEnabled in interface CfnReplicationGroupProps

See Also:

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

getAuthToken

public final String getAuthToken()

Description copied from interface: CfnReplicationGroupProps

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 .

Specified by:

getAuthToken in interface CfnReplicationGroupProps

See Also:

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

getAutomaticFailoverEnabled

public final Object getAutomaticFailoverEnabled()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getAutomaticFailoverEnabled in interface CfnReplicationGroupProps

See Also:

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

getAutoMinorVersionUpgrade

public final Object getAutoMinorVersionUpgrade()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getAutoMinorVersionUpgrade in interface CfnReplicationGroupProps

See Also:

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

getCacheNodeType

public final String getCacheNodeType()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getCacheNodeType in interface CfnReplicationGroupProps

See Also:

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

getCacheParameterGroupName

public final String getCacheParameterGroupName()

Description copied from interface: CfnReplicationGroupProps

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 .

Specified by:

getCacheParameterGroupName in interface CfnReplicationGroupProps

See Also:

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

getCacheSecurityGroupNames

public final List<String> getCacheSecurityGroupNames()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getCacheSecurityGroupNames in interface CfnReplicationGroupProps

See Also:

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

getCacheSubnetGroupName

public final String getCacheSubnetGroupName()

Description copied from interface: CfnReplicationGroupProps

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 .

Specified by:

getCacheSubnetGroupName in interface CfnReplicationGroupProps

See Also:

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

getClusterMode

public final String getClusterMode()

Description copied from interface: CfnReplicationGroupProps

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 .

Specified by:

getClusterMode in interface CfnReplicationGroupProps

See Also:

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

getDataTieringEnabled

public final Object getDataTieringEnabled()

Description copied from interface: CfnReplicationGroupProps

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 .

Specified by:

getDataTieringEnabled in interface CfnReplicationGroupProps

See Also:

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

getEngine

public final String getEngine()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getEngine in interface CfnReplicationGroupProps

See Also:

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

getEngineVersion

public final String getEngineVersion()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getEngineVersion in interface CfnReplicationGroupProps

See Also:

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

getGlobalReplicationGroupId

public final String getGlobalReplicationGroupId()

Description copied from interface: CfnReplicationGroupProps

The name of the Global datastore.

Specified by:

getGlobalReplicationGroupId in interface CfnReplicationGroupProps

See Also:

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

getIpDiscovery

public final String getIpDiscovery()

Description copied from interface: CfnReplicationGroupProps

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 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system .

Specified by:

getIpDiscovery in interface CfnReplicationGroupProps

See Also:

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

getKmsKeyId

public final String getKmsKeyId()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getKmsKeyId in interface CfnReplicationGroupProps

See Also:

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

getLogDeliveryConfigurations

public final Object getLogDeliveryConfigurations()

Description copied from interface: CfnReplicationGroupProps

Specifies the destination, format and type of the logs.

Specified by:

getLogDeliveryConfigurations in interface CfnReplicationGroupProps

See Also:

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

getMultiAzEnabled

public final Object getMultiAzEnabled()

Description copied from interface: CfnReplicationGroupProps

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

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

Specified by:

getMultiAzEnabled in interface CfnReplicationGroupProps

See Also:

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

getNetworkType

public final String getNetworkType()

Description copied from interface: CfnReplicationGroupProps

Must be either ipv4 | ipv6 | dual_stack .

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

Specified by:

getNetworkType in interface CfnReplicationGroupProps

See Also:

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

getNodeGroupConfiguration

public final Object getNodeGroupConfiguration()

Description copied from interface: CfnReplicationGroupProps

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 .

Specified by:

getNodeGroupConfiguration in interface CfnReplicationGroupProps

See Also:

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

getNotificationTopicArn

public final String getNotificationTopicArn()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getNotificationTopicArn in interface CfnReplicationGroupProps

See Also:

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

getNumCacheClusters

public final Number getNumCacheClusters()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getNumCacheClusters in interface CfnReplicationGroupProps

See Also:

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

getNumNodeGroups

public final Number getNumNodeGroups()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getNumNodeGroups in interface CfnReplicationGroupProps

See Also:

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

getPort

public final Number getPort()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getPort in interface CfnReplicationGroupProps

See Also:

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

getPreferredCacheClusterAZs

public final List<String> getPreferredCacheClusterAZs()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getPreferredCacheClusterAZs in interface CfnReplicationGroupProps

See Also:

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

getPreferredMaintenanceWindow

public final String getPreferredMaintenanceWindow()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getPreferredMaintenanceWindow in interface CfnReplicationGroupProps

See Also:

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

getPrimaryClusterId

public final String getPrimaryClusterId()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getPrimaryClusterId in interface CfnReplicationGroupProps

See Also:

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

getReplicasPerNodeGroup

public final Number getReplicasPerNodeGroup()

Description copied from interface: CfnReplicationGroupProps

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

Valid values are 0 to 5.

Specified by:

getReplicasPerNodeGroup in interface CfnReplicationGroupProps

See Also:

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

getReplicationGroupId

public final String getReplicationGroupId()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getReplicationGroupId in interface CfnReplicationGroupProps

See Also:

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

getSecurityGroupIds

public final List<String> getSecurityGroupIds()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getSecurityGroupIds in interface CfnReplicationGroupProps

See Also:

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

getSnapshotArns

public final List<String> getSnapshotArns()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getSnapshotArns in interface CfnReplicationGroupProps

See Also:

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

getSnapshotName

public final String getSnapshotName()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getSnapshotName in interface CfnReplicationGroupProps

See Also:

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

getSnapshotRetentionLimit

public final Number getSnapshotRetentionLimit()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getSnapshotRetentionLimit in interface CfnReplicationGroupProps

See Also:

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

getSnapshottingClusterId

public final String getSnapshottingClusterId()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getSnapshottingClusterId in interface CfnReplicationGroupProps

See Also:

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

getSnapshotWindow

public final String getSnapshotWindow()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getSnapshotWindow in interface CfnReplicationGroupProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getTags in interface CfnReplicationGroupProps

See Also:

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

getTransitEncryptionEnabled

public final Object getTransitEncryptionEnabled()

Description copied from interface: CfnReplicationGroupProps

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 .

Specified by:

getTransitEncryptionEnabled in interface CfnReplicationGroupProps

See Also:

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

getTransitEncryptionMode

public final String getTransitEncryptionMode()

Description copied from interface: CfnReplicationGroupProps

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.

Specified by:

getTransitEncryptionMode in interface CfnReplicationGroupProps

See Also:

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

getUserGroupIds

public final List<String> getUserGroupIds()

Description copied from interface: CfnReplicationGroupProps

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

Specified by:

getUserGroupIds in interface CfnReplicationGroupProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object