software.amazon.awscdk.services.elasticache

Class CfnReplicationGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.elasticache.CfnReplicationGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.987Z")
 @Stability(value=Stable)
public class CfnReplicationGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElastiCache::ReplicationGroup`.

The AWS::ElastiCache::ReplicationGroup resource creates an Amazon ElastiCache Redis replication group. A Redis (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 Redis (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 Redis engine version is 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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.*;
 CfnReplicationGroup cfnReplicationGroup = CfnReplicationGroup.Builder.create(this, "MyCfnReplicationGroup")
         .replicationGroupDescription("replicationGroupDescription")
         // the properties below are optional
         .atRestEncryptionEnabled(false)
         .authToken("authToken")
         .automaticFailoverEnabled(false)
         .autoMinorVersionUpgrade(false)
         .cacheNodeType("cacheNodeType")
         .cacheParameterGroupName("cacheParameterGroupName")
         .cacheSecurityGroupNames(List.of("cacheSecurityGroupNames"))
         .cacheSubnetGroupName("cacheSubnetGroupName")
         .dataTieringEnabled(false)
         .engine("engine")
         .engineVersion("engineVersion")
         .globalReplicationGroupId("globalReplicationGroupId")
         .kmsKeyId("kmsKeyId")
         .logDeliveryConfigurations(List.of(LogDeliveryConfigurationRequestProperty.builder()
                 .destinationDetails(DestinationDetailsProperty.builder()
                         .cloudWatchLogsDetails(CloudWatchLogsDestinationDetailsProperty.builder()
                                 .logGroup("logGroup")
                                 .build())
                         .kinesisFirehoseDetails(KinesisFirehoseDestinationDetailsProperty.builder()
                                 .deliveryStream("deliveryStream")
                                 .build())
                         .build())
                 .destinationType("destinationType")
                 .logFormat("logFormat")
                 .logType("logType")
                 .build()))
         .multiAzEnabled(false)
         .nodeGroupConfiguration(List.of(NodeGroupConfigurationProperty.builder()
                 .nodeGroupId("nodeGroupId")
                 .primaryAvailabilityZone("primaryAvailabilityZone")
                 .replicaAvailabilityZones(List.of("replicaAvailabilityZones"))
                 .replicaCount(123)
                 .slots("slots")
                 .build()))
         .notificationTopicArn("notificationTopicArn")
         .numCacheClusters(123)
         .numNodeGroups(123)
         .port(123)
         .preferredCacheClusterAZs(List.of("preferredCacheClusterAZs"))
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .primaryClusterId("primaryClusterId")
         .replicasPerNodeGroup(123)
         .replicationGroupId("replicationGroupId")
         .securityGroupIds(List.of("securityGroupIds"))
         .snapshotArns(List.of("snapshotArns"))
         .snapshotName("snapshotName")
         .snapshotRetentionLimit(123)
         .snapshottingClusterId("snapshottingClusterId")
         .snapshotWindow("snapshotWindow")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transitEncryptionEnabled(false)
         .userGroupIds(List.of("userGroupIds"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnReplicationGroup.Builder A fluent builder for CfnReplicationGroup.
static interface	CfnReplicationGroup.CloudWatchLogsDestinationDetailsProperty The configuration details of the CloudWatch Logs destination.
static interface	CfnReplicationGroup.DestinationDetailsProperty Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
static interface	CfnReplicationGroup.KinesisFirehoseDestinationDetailsProperty The configuration details of the Kinesis Data Firehose destination.
static interface	CfnReplicationGroup.LogDeliveryConfigurationRequestProperty Specifies the destination, format and type of the logs.
static interface	CfnReplicationGroup.NodeGroupConfigurationProperty `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnReplicationGroup(software.constructs.Construct scope, String id, CfnReplicationGroupProps props) Create a new `AWS::ElastiCache::ReplicationGroup`.
protected	CfnReplicationGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnReplicationGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAtRestEncryptionEnabled() A flag that enables encryption at rest when set to `true` .
String	getAttrConfigurationEndPointAddress() The DNS hostname of the cache node.
String	getAttrConfigurationEndPointPort() The port number that the cache engine is listening on.
String	getAttrPrimaryEndPointAddress() The DNS address of the primary read-write cache node.
String	getAttrPrimaryEndPointPort() The number of the port that the primary read-write cache engine is listening on.
String	getAttrReadEndPointAddresses() A string with a list of endpoints for the primary and read-only replicas.
List<String>	getAttrReadEndPointAddressesList() A string with a list of endpoints for the read-only replicas.
String	getAttrReadEndPointPorts() A string with a list of ports for the read-only replicas.
List<String>	getAttrReadEndPointPortsList() A string with a list of ports for the read-only replicas.
String	getAttrReaderEndPointAddress() The address of the reader endpoint.
String	getAttrReaderEndPointPort() The port used by the reader endpoint.
String	getAuthToken() *Reserved parameter.* The password used to access a password protected server.
Object	getAutomaticFailoverEnabled() Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
Object	getAutoMinorVersionUpgrade() If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
String	getCacheNodeType() The compute and memory capacity of the nodes in the node group (shard).
String	getCacheParameterGroupName() The name of the parameter group to associate with this replication group.
List<String>	getCacheSecurityGroupNames() A list of cache security group names to associate with this replication group.
String	getCacheSubnetGroupName() The name of the cache subnet group to be used for the replication group.
protected Map<String,Object>	getCfnProperties()
Object	getDataTieringEnabled() Enables data tiering.
String	getEngine() The name of the cache engine to be used for the clusters in this replication group.
String	getEngineVersion() The version number of the cache engine to be used for the clusters in this replication group.
String	getGlobalReplicationGroupId() The name of the Global datastore.
String	getKmsKeyId() The ID of the KMS key used to encrypt the disk on the cluster.
Object	getLogDeliveryConfigurations() Specifies the destination, format and type of the logs.
Object	getMultiAzEnabled() A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
Object	getNodeGroupConfiguration() `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
String	getNotificationTopicArn() The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
Number	getNumCacheClusters() The number of clusters this replication group initially has.
Number	getNumNodeGroups() An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group.
Number	getPort() The port number on which each member of the replication group accepts connections.
List<String>	getPreferredCacheClusterAZs() A list of EC2 Availability Zones in which the replication group's clusters are created.
String	getPreferredMaintenanceWindow() Specifies the weekly time range during which maintenance on the cluster is performed.
String	getPrimaryClusterId() The identifier of the cluster that serves as the primary for this replication group.
Number	getReplicasPerNodeGroup() An optional parameter that specifies the number of replica nodes in each node group (shard).
String	getReplicationGroupDescription() A user-created description for the replication group.
String	getReplicationGroupId() The replication group identifier.
List<String>	getSecurityGroupIds() One or more Amazon VPC security groups associated with this replication group.
List<String>	getSnapshotArns() A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
String	getSnapshotName() The name of a snapshot from which to restore data into the new replication group.
Number	getSnapshotRetentionLimit() The number of days for which ElastiCache retains automatic snapshots before deleting them.
String	getSnapshottingClusterId() The cluster ID that is used as the daily snapshot source for the replication group.
String	getSnapshotWindow() The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
TagManager	getTags() A list of tags to be added to this resource.
Object	getTransitEncryptionEnabled() A flag that enables in-transit encryption when set to `true` .
List<String>	getUserGroupIds() The list of user groups to associate with the replication group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAtRestEncryptionEnabled(Boolean value) A flag that enables encryption at rest when set to `true` .
void	setAtRestEncryptionEnabled(IResolvable value) A flag that enables encryption at rest when set to `true` .
void	setAuthToken(String value) *Reserved parameter.* The password used to access a password protected server.
void	setAutomaticFailoverEnabled(Boolean value) Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
void	setAutomaticFailoverEnabled(IResolvable value) Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
void	setAutoMinorVersionUpgrade(Boolean value) If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
void	setAutoMinorVersionUpgrade(IResolvable value) If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
void	setCacheNodeType(String value) The compute and memory capacity of the nodes in the node group (shard).
void	setCacheParameterGroupName(String value) The name of the parameter group to associate with this replication group.
void	setCacheSecurityGroupNames(List<String> value) A list of cache security group names to associate with this replication group.
void	setCacheSubnetGroupName(String value) The name of the cache subnet group to be used for the replication group.
void	setDataTieringEnabled(Boolean value) Enables data tiering.
void	setDataTieringEnabled(IResolvable value) Enables data tiering.
void	setEngine(String value) The name of the cache engine to be used for the clusters in this replication group.
void	setEngineVersion(String value) The version number of the cache engine to be used for the clusters in this replication group.
void	setGlobalReplicationGroupId(String value) The name of the Global datastore.
void	setKmsKeyId(String value) The ID of the KMS key used to encrypt the disk on the cluster.
void	setLogDeliveryConfigurations(IResolvable value) Specifies the destination, format and type of the logs.
void	setLogDeliveryConfigurations(List<Object> value) Specifies the destination, format and type of the logs.
void	setMultiAzEnabled(Boolean value) A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
void	setMultiAzEnabled(IResolvable value) A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
void	setNodeGroupConfiguration(IResolvable value) `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
void	setNodeGroupConfiguration(List<Object> value) `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
void	setNotificationTopicArn(String value) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
void	setNumCacheClusters(Number value) The number of clusters this replication group initially has.
void	setNumNodeGroups(Number value) An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group.
void	setPort(Number value) The port number on which each member of the replication group accepts connections.
void	setPreferredCacheClusterAZs(List<String> value) A list of EC2 Availability Zones in which the replication group's clusters are created.
void	setPreferredMaintenanceWindow(String value) Specifies the weekly time range during which maintenance on the cluster is performed.
void	setPrimaryClusterId(String value) The identifier of the cluster that serves as the primary for this replication group.
void	setReplicasPerNodeGroup(Number value) An optional parameter that specifies the number of replica nodes in each node group (shard).
void	setReplicationGroupDescription(String value) A user-created description for the replication group.
void	setReplicationGroupId(String value) The replication group identifier.
void	setSecurityGroupIds(List<String> value) One or more Amazon VPC security groups associated with this replication group.
void	setSnapshotArns(List<String> value) A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
void	setSnapshotName(String value) The name of a snapshot from which to restore data into the new replication group.
void	setSnapshotRetentionLimit(Number value) The number of days for which ElastiCache retains automatic snapshots before deleting them.
void	setSnapshottingClusterId(String value) The cluster ID that is used as the daily snapshot source for the replication group.
void	setSnapshotWindow(String value) The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
void	setTransitEncryptionEnabled(Boolean value) A flag that enables in-transit encryption when set to `true` .
void	setTransitEncryptionEnabled(IResolvable value) A flag that enables in-transit encryption when set to `true` .
void	setUserGroupIds(List<String> value) The list of user groups to associate with the replication group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnReplicationGroup

protected CfnReplicationGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnReplicationGroup

protected CfnReplicationGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnReplicationGroup

@Stability(value=Stable)
public CfnReplicationGroup(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    CfnReplicationGroupProps props)

Create a new `AWS::ElastiCache::ReplicationGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConfigurationEndPointAddress

@Stability(value=Stable)
 @NotNull
public String getAttrConfigurationEndPointAddress()

The DNS hostname of the cache node.

Redis (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 Redis (cluster mode disabled) replication groups, use the PrimaryEndpoint or ReadEndpoint attributes.

getAttrConfigurationEndPointPort

@Stability(value=Stable)
 @NotNull
public String getAttrConfigurationEndPointPort()

The port number that the cache engine is listening on.

getAttrPrimaryEndPointAddress

@Stability(value=Stable)
 @NotNull
public String getAttrPrimaryEndPointAddress()

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

getAttrPrimaryEndPointPort

@Stability(value=Stable)
 @NotNull
public String getAttrPrimaryEndPointPort()

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

getAttrReadEndPointAddresses

@Stability(value=Stable)
 @NotNull
public String getAttrReadEndPointAddresses()

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.

getAttrReadEndPointAddressesList

@Stability(value=Stable)
 @NotNull
public List<String> getAttrReadEndPointAddressesList()

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.

getAttrReadEndPointPorts

@Stability(value=Stable)
 @NotNull
public String getAttrReadEndPointPorts()

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.

getAttrReadEndPointPortsList

@Stability(value=Stable)
 @NotNull
public List<String> getAttrReadEndPointPortsList()

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.

getAttrReaderEndPointAddress

@Stability(value=Stable)
 @NotNull
public String getAttrReaderEndPointAddress()

The address of the reader endpoint.

getAttrReaderEndPointPort

@Stability(value=Stable)
 @NotNull
public String getAttrReaderEndPointPort()

The port used by the reader endpoint.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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.

getReplicationGroupDescription

@Stability(value=Stable)
 @NotNull
public String getReplicationGroupDescription()

A user-created description for the replication group.

setReplicationGroupDescription

@Stability(value=Stable)
public void setReplicationGroupDescription(@NotNull
                                                                    String value)

A user-created description for the replication group.

getAtRestEncryptionEnabled

@Stability(value=Stable)
 @Nullable
public Object getAtRestEncryptionEnabled()

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 version 3.2.6 or 4.x onward.

Default: false

setAtRestEncryptionEnabled

@Stability(value=Stable)
public void setAtRestEncryptionEnabled(@Nullable
                                                                Boolean value)

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 version 3.2.6 or 4.x onward.

Default: false

setAtRestEncryptionEnabled

@Stability(value=Stable)
public void setAtRestEncryptionEnabled(@Nullable
                                                                IResolvable value)

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 version 3.2.6 or 4.x onward.

Default: false

getAuthToken

@Stability(value=Stable)
 @Nullable
public String getAuthToken()

*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 Users with the Redis 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.

setAuthToken

@Stability(value=Stable)
public void setAuthToken(@Nullable
                                                  String value)

*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 Users with the Redis 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.

getAutomaticFailoverEnabled

@Stability(value=Stable)
 @Nullable
public Object getAutomaticFailoverEnabled()

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

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

Default: false

setAutomaticFailoverEnabled

@Stability(value=Stable)
public void setAutomaticFailoverEnabled(@Nullable
                                                                 Boolean value)

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

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

Default: false

setAutomaticFailoverEnabled

@Stability(value=Stable)
public void setAutomaticFailoverEnabled(@Nullable
                                                                 IResolvable value)

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

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

Default: false

getAutoMinorVersionUpgrade

@Stability(value=Stable)
 @Nullable
public Object getAutoMinorVersionUpgrade()

If you are running Redis engine version 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.

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                Boolean value)

If you are running Redis engine version 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.

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                IResolvable value)

If you are running Redis engine version 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.

getCacheNodeType

@Stability(value=Stable)
 @Nullable
public String getCacheNodeType()

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

setCacheNodeType

@Stability(value=Stable)
public void setCacheNodeType(@Nullable
                                                      String value)

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

getCacheParameterGroupName

@Stability(value=Stable)
 @Nullable
public String getCacheParameterGroupName()

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 Redis 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 Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2 .
• To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on .

setCacheParameterGroupName

@Stability(value=Stable)
public void setCacheParameterGroupName(@Nullable
                                                                String value)

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 Redis 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 Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2 .
• To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on .

getCacheSecurityGroupNames

@Stability(value=Stable)
 @Nullable
public List<String> getCacheSecurityGroupNames()

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

setCacheSecurityGroupNames

@Stability(value=Stable)
public void setCacheSecurityGroupNames(@Nullable
                                                                List<String> value)

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

getCacheSubnetGroupName

@Stability(value=Stable)
 @Nullable
public String getCacheSubnetGroupName()

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 .

setCacheSubnetGroupName

@Stability(value=Stable)
public void setCacheSubnetGroupName(@Nullable
                                                             String value)

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 .

getDataTieringEnabled

@Stability(value=Stable)
 @Nullable
public Object getDataTieringEnabled()

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 .

setDataTieringEnabled

@Stability(value=Stable)
public void setDataTieringEnabled(@Nullable
                                                           Boolean value)

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 .

setDataTieringEnabled

@Stability(value=Stable)
public void setDataTieringEnabled(@Nullable
                                                           IResolvable value)

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 .

getEngine

@Stability(value=Stable)
 @Nullable
public String getEngine()

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

Must be Redis.

setEngine

@Stability(value=Stable)
public void setEngine(@Nullable
                                               String value)

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

Must be Redis.

getEngineVersion

@Stability(value=Stable)
 @Nullable
public String getEngineVersion()

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.

setEngineVersion

@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)

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.

getGlobalReplicationGroupId

@Stability(value=Stable)
 @Nullable
public String getGlobalReplicationGroupId()

The name of the Global datastore.

setGlobalReplicationGroupId

@Stability(value=Stable)
public void setGlobalReplicationGroupId(@Nullable
                                                                 String value)

The name of the Global datastore.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()

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

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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

getLogDeliveryConfigurations

@Stability(value=Stable)
 @Nullable
public Object getLogDeliveryConfigurations()

Specifies the destination, format and type of the logs.

setLogDeliveryConfigurations

@Stability(value=Stable)
public void setLogDeliveryConfigurations(@Nullable
                                                                  IResolvable value)

Specifies the destination, format and type of the logs.

setLogDeliveryConfigurations

@Stability(value=Stable)
public void setLogDeliveryConfigurations(@Nullable
                                                                  List<Object> value)

Specifies the destination, format and type of the logs.

getMultiAzEnabled

@Stability(value=Stable)
 @Nullable
public Object getMultiAzEnabled()

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

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

setMultiAzEnabled

@Stability(value=Stable)
public void setMultiAzEnabled(@Nullable
                                                       Boolean value)

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

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

setMultiAzEnabled

@Stability(value=Stable)
public void setMultiAzEnabled(@Nullable
                                                       IResolvable value)

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

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

getNodeGroupConfiguration

@Stability(value=Stable)
 @Nullable
public Object getNodeGroupConfiguration()

`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis 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 .

setNodeGroupConfiguration

@Stability(value=Stable)
public void setNodeGroupConfiguration(@Nullable
                                                               IResolvable value)

`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis 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 .

setNodeGroupConfiguration

@Stability(value=Stable)
public void setNodeGroupConfiguration(@Nullable
                                                               List<Object> value)

`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis 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 .

getNotificationTopicArn

@Stability(value=Stable)
 @Nullable
public String getNotificationTopicArn()

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.

setNotificationTopicArn

@Stability(value=Stable)
public void setNotificationTopicArn(@Nullable
                                                             String value)

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.

getNumCacheClusters

@Stability(value=Stable)
 @Nullable
public Number getNumCacheClusters()

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

setNumCacheClusters

@Stability(value=Stable)
public void setNumCacheClusters(@Nullable
                                                         Number value)

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

getNumNodeGroups

@Stability(value=Stable)
 @Nullable
public Number getNumNodeGroups()

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

For Redis (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

setNumNodeGroups

@Stability(value=Stable)
public void setNumNodeGroups(@Nullable
                                                      Number value)

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

For Redis (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

getPort

@Stability(value=Stable)
 @Nullable
public Number getPort()

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

setPort

@Stability(value=Stable)
public void setPort(@Nullable
                                             Number value)

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

getPreferredCacheClusterAZs

@Stability(value=Stable)
 @Nullable
public List<String> getPreferredCacheClusterAZs()

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.

setPreferredCacheClusterAZs

@Stability(value=Stable)
public void setPreferredCacheClusterAZs(@Nullable
                                                                 List<String> value)

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.

getPreferredMaintenanceWindow

@Stability(value=Stable)
 @Nullable
public String getPreferredMaintenanceWindow()

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

setPreferredMaintenanceWindow

@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
                                                                   String value)

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

getPrimaryClusterId

@Stability(value=Stable)
 @Nullable
public String getPrimaryClusterId()

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.

setPrimaryClusterId

@Stability(value=Stable)
public void setPrimaryClusterId(@Nullable
                                                         String value)

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.

getReplicasPerNodeGroup

@Stability(value=Stable)
 @Nullable
public Number getReplicasPerNodeGroup()

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

Valid values are 0 to 5.

setReplicasPerNodeGroup

@Stability(value=Stable)
public void setReplicasPerNodeGroup(@Nullable
                                                             Number value)

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

Valid values are 0 to 5.

getReplicationGroupId

@Stability(value=Stable)
 @Nullable
public String getReplicationGroupId()

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.

setReplicationGroupId

@Stability(value=Stable)
public void setReplicationGroupId(@Nullable
                                                           String value)

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.

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getSecurityGroupIds()

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

setSecurityGroupIds

@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
                                                         List<String> value)

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

getSnapshotArns

@Stability(value=Stable)
 @Nullable
public List<String> getSnapshotArns()

A list of Amazon Resource Names (ARN) that uniquely identify the Redis 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

setSnapshotArns

@Stability(value=Stable)
public void setSnapshotArns(@Nullable
                                                     List<String> value)

A list of Amazon Resource Names (ARN) that uniquely identify the Redis 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

getSnapshotName

@Stability(value=Stable)
 @Nullable
public String getSnapshotName()

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.

setSnapshotName

@Stability(value=Stable)
public void setSnapshotName(@Nullable
                                                     String value)

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.

getSnapshotRetentionLimit

@Stability(value=Stable)
 @Nullable
public Number getSnapshotRetentionLimit()

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

setSnapshotRetentionLimit

@Stability(value=Stable)
public void setSnapshotRetentionLimit(@Nullable
                                                               Number value)

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

getSnapshottingClusterId

@Stability(value=Stable)
 @Nullable
public String getSnapshottingClusterId()

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

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

setSnapshottingClusterId

@Stability(value=Stable)
public void setSnapshottingClusterId(@Nullable
                                                              String value)

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

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

getSnapshotWindow

@Stability(value=Stable)
 @Nullable
public String getSnapshotWindow()

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.

setSnapshotWindow

@Stability(value=Stable)
public void setSnapshotWindow(@Nullable
                                                       String value)

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.

getTransitEncryptionEnabled

@Stability(value=Stable)
 @Nullable
public Object getTransitEncryptionEnabled()

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 .

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

Default: false

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

setTransitEncryptionEnabled

@Stability(value=Stable)
public void setTransitEncryptionEnabled(@Nullable
                                                                 Boolean value)

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 .

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

Default: false

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

setTransitEncryptionEnabled

@Stability(value=Stable)
public void setTransitEncryptionEnabled(@Nullable
                                                                 IResolvable value)

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 .

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

Default: false

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

getUserGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getUserGroupIds()

The list of user groups to associate with the replication group.

setUserGroupIds

@Stability(value=Stable)
public void setUserGroupIds(@Nullable
                                                     List<String> value)

The list of user groups to associate with the replication group.