@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.959Z") public class CfnReplicationGroup extends CfnResource implements IInspectable
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") .ipDiscovery("ipDiscovery") .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) .networkType("networkType") .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) .transitEncryptionMode("transitEncryptionMode") .userGroupIds(List.of("userGroupIds")) .build();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnReplicationGroup(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getAtRestEncryptionEnabled()
A flag that enables encryption at rest when set to `true` .
|
java.lang.String |
getAttrConfigurationEndPointAddress()
The DNS hostname of the cache node.
|
java.lang.String |
getAttrConfigurationEndPointPort()
The port number that the cache engine is listening on.
|
java.lang.String |
getAttrPrimaryEndPointAddress()
The DNS address of the primary read-write cache node.
|
java.lang.String |
getAttrPrimaryEndPointPort()
The number of the port that the primary read-write cache engine is listening on.
|
java.lang.String |
getAttrReadEndPointAddresses()
A string with a list of endpoints for the primary and read-only replicas.
|
java.util.List<java.lang.String> |
getAttrReadEndPointAddressesList()
A string with a list of endpoints for the read-only replicas.
|
java.lang.String |
getAttrReadEndPointPorts()
A string with a list of ports for the read-only replicas.
|
java.util.List<java.lang.String> |
getAttrReadEndPointPortsList()
A string with a list of ports for the read-only replicas.
|
java.lang.String |
getAttrReaderEndPointAddress()
The address of the reader endpoint.
|
java.lang.String |
getAttrReaderEndPointPort()
The port used by the reader endpoint.
|
java.lang.String |
getAuthToken()
*Reserved parameter.* The password used to access a password protected server.
|
java.lang.Object |
getAutomaticFailoverEnabled()
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
|
java.lang.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.
|
java.lang.String |
getCacheNodeType()
The compute and memory capacity of the nodes in the node group (shard).
|
java.lang.String |
getCacheParameterGroupName()
The name of the parameter group to associate with this replication group.
|
java.util.List<java.lang.String> |
getCacheSecurityGroupNames()
A list of cache security group names to associate with this replication group.
|
java.lang.String |
getCacheSubnetGroupName()
The name of the cache subnet group to be used for the replication group.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getDataTieringEnabled()
Enables data tiering.
|
java.lang.String |
getEngine()
The name of the cache engine to be used for the clusters in this replication group.
|
java.lang.String |
getEngineVersion()
The version number of the cache engine to be used for the clusters in this replication group.
|
java.lang.String |
getGlobalReplicationGroupId()
The name of the Global datastore.
|
java.lang.String |
getIpDiscovery()
The network type you choose when creating a replication group, either `ipv4` | `ipv6` .
|
java.lang.String |
getKmsKeyId()
The ID of the KMS key used to encrypt the disk on the cluster.
|
java.lang.Object |
getLogDeliveryConfigurations()
Specifies the destination, format and type of the logs.
|
java.lang.Object |
getMultiAzEnabled()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
|
java.lang.String |
getNetworkType()
Must be either `ipv4` | `ipv6` | `dual_stack` .
|
java.lang.Object |
getNodeGroupConfiguration()
`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
|
java.lang.String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
|
java.lang.Number |
getNumCacheClusters()
The number of clusters this replication group initially has.
|
java.lang.Number |
getNumNodeGroups()
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group.
|
java.lang.Number |
getPort()
The port number on which each member of the replication group accepts connections.
|
java.util.List<java.lang.String> |
getPreferredCacheClusterAZs()
A list of EC2 Availability Zones in which the replication group's clusters are created.
|
java.lang.String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
java.lang.String |
getPrimaryClusterId()
The identifier of the cluster that serves as the primary for this replication group.
|
java.lang.Number |
getReplicasPerNodeGroup()
An optional parameter that specifies the number of replica nodes in each node group (shard).
|
java.lang.String |
getReplicationGroupDescription()
A user-created description for the replication group.
|
java.lang.String |
getReplicationGroupId()
The replication group identifier.
|
java.util.List<java.lang.String> |
getSecurityGroupIds()
One or more Amazon VPC security groups associated with this replication group.
|
java.util.List<java.lang.String> |
getSnapshotArns()
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
|
java.lang.String |
getSnapshotName()
The name of a snapshot from which to restore data into the new replication group.
|
java.lang.Number |
getSnapshotRetentionLimit()
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
java.lang.String |
getSnapshottingClusterId()
The cluster ID that is used as the daily snapshot source for the replication group.
|
java.lang.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.
|
java.lang.Object |
getTransitEncryptionEnabled()
A flag that enables in-transit encryption when set to `true` .
|
java.lang.String |
getTransitEncryptionMode()
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
|
java.util.List<java.lang.String> |
getUserGroupIds()
The ID of user group to associate with the replication group.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAtRestEncryptionEnabled(java.lang.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(java.lang.String value)
*Reserved parameter.* The password used to access a password protected server.
|
void |
setAutomaticFailoverEnabled(java.lang.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(java.lang.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(java.lang.String value)
The compute and memory capacity of the nodes in the node group (shard).
|
void |
setCacheParameterGroupName(java.lang.String value)
The name of the parameter group to associate with this replication group.
|
void |
setCacheSecurityGroupNames(java.util.List<java.lang.String> value)
A list of cache security group names to associate with this replication group.
|
void |
setCacheSubnetGroupName(java.lang.String value)
The name of the cache subnet group to be used for the replication group.
|
void |
setDataTieringEnabled(java.lang.Boolean value)
Enables data tiering.
|
void |
setDataTieringEnabled(IResolvable value)
Enables data tiering.
|
void |
setEngine(java.lang.String value)
The name of the cache engine to be used for the clusters in this replication group.
|
void |
setEngineVersion(java.lang.String value)
The version number of the cache engine to be used for the clusters in this replication group.
|
void |
setGlobalReplicationGroupId(java.lang.String value)
The name of the Global datastore.
|
void |
setIpDiscovery(java.lang.String value)
The network type you choose when creating a replication group, either `ipv4` | `ipv6` .
|
void |
setKmsKeyId(java.lang.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(java.util.List<java.lang.Object> value)
Specifies the destination, format and type of the logs.
|
void |
setMultiAzEnabled(java.lang.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 |
setNetworkType(java.lang.String value)
Must be either `ipv4` | `ipv6` | `dual_stack` .
|
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(java.util.List<java.lang.Object> value)
`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
|
void |
setNotificationTopicArn(java.lang.String value)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
|
void |
setNumCacheClusters(java.lang.Number value)
The number of clusters this replication group initially has.
|
void |
setNumNodeGroups(java.lang.Number value)
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group.
|
void |
setPort(java.lang.Number value)
The port number on which each member of the replication group accepts connections.
|
void |
setPreferredCacheClusterAZs(java.util.List<java.lang.String> value)
A list of EC2 Availability Zones in which the replication group's clusters are created.
|
void |
setPreferredMaintenanceWindow(java.lang.String value)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
void |
setPrimaryClusterId(java.lang.String value)
The identifier of the cluster that serves as the primary for this replication group.
|
void |
setReplicasPerNodeGroup(java.lang.Number value)
An optional parameter that specifies the number of replica nodes in each node group (shard).
|
void |
setReplicationGroupDescription(java.lang.String value)
A user-created description for the replication group.
|
void |
setReplicationGroupId(java.lang.String value)
The replication group identifier.
|
void |
setSecurityGroupIds(java.util.List<java.lang.String> value)
One or more Amazon VPC security groups associated with this replication group.
|
void |
setSnapshotArns(java.util.List<java.lang.String> value)
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
|
void |
setSnapshotName(java.lang.String value)
The name of a snapshot from which to restore data into the new replication group.
|
void |
setSnapshotRetentionLimit(java.lang.Number value)
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
void |
setSnapshottingClusterId(java.lang.String value)
The cluster ID that is used as the daily snapshot source for the replication group.
|
void |
setSnapshotWindow(java.lang.String value)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
void |
setTransitEncryptionEnabled(java.lang.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 |
setTransitEncryptionMode(java.lang.String value)
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
|
void |
setUserGroupIds(java.util.List<java.lang.String> value)
The ID of user group to associate with the replication group.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnReplicationGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnReplicationGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnReplicationGroup(Construct scope, java.lang.String id, CfnReplicationGroupProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrConfigurationEndPointAddress()
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 thePrimaryEndpoint
orReadEndpoint
attributes.
public java.lang.String getAttrConfigurationEndPointPort()
public java.lang.String getAttrPrimaryEndPointAddress()
public java.lang.String getAttrPrimaryEndPointPort()
public java.lang.String getAttrReadEndPointAddresses()
The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports
attribute.
public java.util.List<java.lang.String> getAttrReadEndPointAddressesList()
The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports
attribute.
public java.lang.String getAttrReadEndPointPorts()
The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses
attribute.
public java.util.List<java.lang.String> getAttrReadEndPointPortsList()
The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
public java.lang.String getAttrReaderEndPointAddress()
public java.lang.String getAttrReaderEndPointPort()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
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.
public java.lang.String getReplicationGroupDescription()
public void setReplicationGroupDescription(java.lang.String value)
public java.lang.Object getAtRestEncryptionEnabled()
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
public void setAtRestEncryptionEnabled(java.lang.Boolean value)
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
public void setAtRestEncryptionEnabled(IResolvable value)
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
public java.lang.String getAuthToken()
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
astrue
, anAuthToken
, and aCacheSubnetGroup
.
Password constraints:
For more information, see AUTH password at http://redis.io/commands/AUTH.
If ADDING the AuthToken, update requires Replacement .
public void setAuthToken(java.lang.String value)
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
astrue
, anAuthToken
, and aCacheSubnetGroup
.
Password constraints:
For more information, see AUTH password at http://redis.io/commands/AUTH.
If ADDING the AuthToken, update requires Replacement .
public java.lang.Object getAutomaticFailoverEnabled()
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
public void setAutomaticFailoverEnabled(java.lang.Boolean value)
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
public void setAutomaticFailoverEnabled(IResolvable value)
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
public java.lang.Object getAutoMinorVersionUpgrade()
public void setAutoMinorVersionUpgrade(java.lang.Boolean value)
public void setAutoMinorVersionUpgrade(IResolvable value)
public java.lang.String getCacheNodeType()
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.
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
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
C1 node types: cache.c1.xlarge
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
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
public void setCacheNodeType(java.lang.String value)
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.
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
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
C1 node types: cache.c1.xlarge
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
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
public java.lang.String getCacheParameterGroupName()
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.
CacheParameterGroupName=default.redis3.2
.CacheParameterGroupName=default.redis3.2.cluster.on
.public void setCacheParameterGroupName(java.lang.String value)
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.
CacheParameterGroupName=default.redis3.2
.CacheParameterGroupName=default.redis3.2.cluster.on
.public java.util.List<java.lang.String> getCacheSecurityGroupNames()
public void setCacheSecurityGroupNames(java.util.List<java.lang.String> value)
public java.lang.String getCacheSubnetGroupName()
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 .
public void setCacheSubnetGroupName(java.lang.String value)
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 .
public java.lang.Object getDataTieringEnabled()
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 .
public void setDataTieringEnabled(java.lang.Boolean value)
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 .
public void setDataTieringEnabled(IResolvable value)
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 .
public java.lang.String getEngine()
The value must be set to Redis
.
public void setEngine(java.lang.String value)
The value must be set to Redis
.
public java.lang.String getEngineVersion()
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.
public void setEngineVersion(java.lang.String value)
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.
public java.lang.String getGlobalReplicationGroupId()
public void setGlobalReplicationGroupId(java.lang.String value)
public java.lang.String getIpDiscovery()
IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .
public void setIpDiscovery(java.lang.String value)
IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .
public java.lang.String getKmsKeyId()
public void setKmsKeyId(java.lang.String value)
public java.lang.Object getLogDeliveryConfigurations()
public void setLogDeliveryConfigurations(IResolvable value)
public void setLogDeliveryConfigurations(java.util.List<java.lang.Object> value)
public java.lang.Object getMultiAzEnabled()
For more information, see Minimizing Downtime: Multi-AZ .
public void setMultiAzEnabled(java.lang.Boolean value)
For more information, see Minimizing Downtime: Multi-AZ .
public void setMultiAzEnabled(IResolvable value)
For more information, see Minimizing Downtime: Multi-AZ .
public java.lang.String getNetworkType()
IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .
public void setNetworkType(java.lang.String value)
IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .
public java.lang.Object getNodeGroupConfiguration()
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 .
public void setNodeGroupConfiguration(IResolvable value)
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 .
public void setNodeGroupConfiguration(java.util.List<java.lang.Object> value)
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 .
public java.lang.String getNotificationTopicArn()
The Amazon SNS topic owner must be the same as the cluster owner.
public void setNotificationTopicArn(java.lang.String value)
The Amazon SNS topic owner must be the same as the cluster owner.
public java.lang.Number getNumCacheClusters()
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).
public void setNumCacheClusters(java.lang.Number value)
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).
public java.lang.Number getNumNodeGroups()
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
public void setNumNodeGroups(java.lang.Number value)
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
public java.lang.Number getPort()
public void setPort(java.lang.Number value)
public java.util.List<java.lang.String> getPreferredCacheClusterAZs()
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.
public void setPreferredCacheClusterAZs(java.util.List<java.lang.String> value)
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.
public java.lang.String getPreferredMaintenanceWindow()
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
public void setPreferredMaintenanceWindow(java.lang.String value)
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
public java.lang.String getPrimaryClusterId()
This cluster must already exist and have a status of available
.
This parameter is not required if NumCacheClusters
, NumNodeGroups
, or ReplicasPerNodeGroup
is specified.
public void setPrimaryClusterId(java.lang.String value)
This cluster must already exist and have a status of available
.
This parameter is not required if NumCacheClusters
, NumNodeGroups
, or ReplicasPerNodeGroup
is specified.
public java.lang.Number getReplicasPerNodeGroup()
Valid values are 0 to 5.
public void setReplicasPerNodeGroup(java.lang.Number value)
Valid values are 0 to 5.
public java.lang.String getReplicationGroupId()
Constraints:
public void setReplicationGroupId(java.lang.String value)
Constraints:
public java.util.List<java.lang.String> getSecurityGroupIds()
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
public java.util.List<java.lang.String> getSnapshotArns()
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
public void setSnapshotArns(java.util.List<java.lang.String> value)
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
public java.lang.String getSnapshotName()
The snapshot status changes to restoring
while the new replication group is being created.
public void setSnapshotName(java.lang.String value)
The snapshot status changes to restoring
while the new replication group is being created.
public java.lang.Number getSnapshotRetentionLimit()
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).
public void setSnapshotRetentionLimit(java.lang.Number value)
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).
public java.lang.String getSnapshottingClusterId()
This parameter cannot be set for Redis (cluster mode enabled) replication groups.
public void setSnapshottingClusterId(java.lang.String value)
This parameter cannot be set for Redis (cluster mode enabled) replication groups.
public java.lang.String getSnapshotWindow()
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
public void setSnapshotWindow(java.lang.String value)
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
public java.lang.Object getTransitEncryptionEnabled()
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
astrue
, anAuthToken
, and aCacheSubnetGroup
.
public void setTransitEncryptionEnabled(java.lang.Boolean value)
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
astrue
, anAuthToken
, and aCacheSubnetGroup
.
public void setTransitEncryptionEnabled(IResolvable value)
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
astrue
, anAuthToken
, and aCacheSubnetGroup
.
public java.lang.String getTransitEncryptionMode()
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 Redis 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
.
public void setTransitEncryptionMode(java.lang.String value)
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 Redis 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
.
public java.util.List<java.lang.String> getUserGroupIds()
public void setUserGroupIds(java.util.List<java.lang.String> value)