@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a CreateReplicationGroup
operation.
NOOP
Constructor and Description |
---|
CreateReplicationGroupRequest() |
Modifier and Type | Method and Description |
---|---|
CreateReplicationGroupRequest |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAtRestEncryptionEnabled()
A flag that enables encryption at rest when set to
true . |
String |
getAuthToken()
Reserved parameter. The password used to access a password protected server.
|
Boolean |
getAutomaticFailoverEnabled()
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary
fails.
|
Boolean |
getAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
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.
|
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 in the cluster.
|
List<LogDeliveryConfigurationRequest> |
getLogDeliveryConfigurations()
Specifies the destination, format and type of the logs.
|
Boolean |
getMultiAZEnabled()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
|
List<NodeGroupConfiguration> |
getNodeGroupConfiguration()
A list of node group (shard) configuration options.
|
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are
sent.
|
Integer |
getNumCacheClusters()
The number of clusters this replication group initially has.
|
Integer |
getNumNodeGroups()
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled)
replication group.
|
Integer |
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.
|
Integer |
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.
|
Integer |
getSnapshotRetentionLimit()
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
String |
getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
List<Tag> |
getTags()
A list of tags to be added to this resource.
|
Boolean |
getTransitEncryptionEnabled()
A flag that enables in-transit encryption when set to
true . |
List<String> |
getUserGroupIds()
The user group to associate with the replication group.
|
int |
hashCode() |
Boolean |
isAtRestEncryptionEnabled()
A flag that enables encryption at rest when set to
true . |
Boolean |
isAutomaticFailoverEnabled()
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary
fails.
|
Boolean |
isAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
Boolean |
isMultiAZEnabled()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
|
Boolean |
isTransitEncryptionEnabled()
A flag that enables in-transit encryption when set to
true . |
void |
setAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
A flag that enables encryption at rest when set to
true . |
void |
setAuthToken(String authToken)
Reserved parameter. The password used to access a password protected server.
|
void |
setAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary
fails.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
void |
setCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the node group (shard).
|
void |
setCacheParameterGroupName(String cacheParameterGroupName)
The name of the parameter group to associate with this replication group.
|
void |
setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to associate with this replication group.
|
void |
setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group to be used for the replication group.
|
void |
setEngine(String engine)
The name of the cache engine to be used for the clusters in this replication group.
|
void |
setEngineVersion(String engineVersion)
The version number of the cache engine to be used for the clusters in this replication group.
|
void |
setGlobalReplicationGroupId(String globalReplicationGroupId)
The name of the Global datastore
|
void |
setKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the disk in the cluster.
|
void |
setLogDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
|
void |
setMultiAZEnabled(Boolean multiAZEnabled)
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
|
void |
setNodeGroupConfiguration(Collection<NodeGroupConfiguration> nodeGroupConfiguration)
A list of node group (shard) configuration options.
|
void |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are
sent.
|
void |
setNumCacheClusters(Integer numCacheClusters)
The number of clusters this replication group initially has.
|
void |
setNumNodeGroups(Integer numNodeGroups)
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled)
replication group.
|
void |
setPort(Integer port)
The port number on which each member of the replication group accepts connections.
|
void |
setPreferredCacheClusterAZs(Collection<String> preferredCacheClusterAZs)
A list of EC2 Availability Zones in which the replication group's clusters are created.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
void |
setPrimaryClusterId(String primaryClusterId)
The identifier of the cluster that serves as the primary for this replication group.
|
void |
setReplicasPerNodeGroup(Integer replicasPerNodeGroup)
An optional parameter that specifies the number of replica nodes in each node group (shard).
|
void |
setReplicationGroupDescription(String replicationGroupDescription)
A user-created description for the replication group.
|
void |
setReplicationGroupId(String replicationGroupId)
The replication group identifier.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
One or more Amazon VPC security groups associated with this replication group.
|
void |
setSnapshotArns(Collection<String> snapshotArns)
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
|
void |
setSnapshotName(String snapshotName)
The name of a snapshot from which to restore data into the new replication group.
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
void |
setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
void |
setTags(Collection<Tag> tags)
A list of tags to be added to this resource.
|
void |
setTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
A flag that enables in-transit encryption when set to
true . |
void |
setUserGroupIds(Collection<String> userGroupIds)
The user group to associate with the replication group.
|
String |
toString()
Returns a string representation of this object.
|
CreateReplicationGroupRequest |
withAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
A flag that enables encryption at rest when set to
true . |
CreateReplicationGroupRequest |
withAuthToken(String authToken)
Reserved parameter. The password used to access a password protected server.
|
CreateReplicationGroupRequest |
withAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary
fails.
|
CreateReplicationGroupRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
CreateReplicationGroupRequest |
withCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the node group (shard).
|
CreateReplicationGroupRequest |
withCacheParameterGroupName(String cacheParameterGroupName)
The name of the parameter group to associate with this replication group.
|
CreateReplicationGroupRequest |
withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to associate with this replication group.
|
CreateReplicationGroupRequest |
withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of cache security group names to associate with this replication group.
|
CreateReplicationGroupRequest |
withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group to be used for the replication group.
|
CreateReplicationGroupRequest |
withEngine(String engine)
The name of the cache engine to be used for the clusters in this replication group.
|
CreateReplicationGroupRequest |
withEngineVersion(String engineVersion)
The version number of the cache engine to be used for the clusters in this replication group.
|
CreateReplicationGroupRequest |
withGlobalReplicationGroupId(String globalReplicationGroupId)
The name of the Global datastore
|
CreateReplicationGroupRequest |
withKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the disk in the cluster.
|
CreateReplicationGroupRequest |
withLogDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
|
CreateReplicationGroupRequest |
withLogDeliveryConfigurations(LogDeliveryConfigurationRequest... logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
|
CreateReplicationGroupRequest |
withMultiAZEnabled(Boolean multiAZEnabled)
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
|
CreateReplicationGroupRequest |
withNodeGroupConfiguration(Collection<NodeGroupConfiguration> nodeGroupConfiguration)
A list of node group (shard) configuration options.
|
CreateReplicationGroupRequest |
withNodeGroupConfiguration(NodeGroupConfiguration... nodeGroupConfiguration)
A list of node group (shard) configuration options.
|
CreateReplicationGroupRequest |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are
sent.
|
CreateReplicationGroupRequest |
withNumCacheClusters(Integer numCacheClusters)
The number of clusters this replication group initially has.
|
CreateReplicationGroupRequest |
withNumNodeGroups(Integer numNodeGroups)
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled)
replication group.
|
CreateReplicationGroupRequest |
withPort(Integer port)
The port number on which each member of the replication group accepts connections.
|
CreateReplicationGroupRequest |
withPreferredCacheClusterAZs(Collection<String> preferredCacheClusterAZs)
A list of EC2 Availability Zones in which the replication group's clusters are created.
|
CreateReplicationGroupRequest |
withPreferredCacheClusterAZs(String... preferredCacheClusterAZs)
A list of EC2 Availability Zones in which the replication group's clusters are created.
|
CreateReplicationGroupRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
CreateReplicationGroupRequest |
withPrimaryClusterId(String primaryClusterId)
The identifier of the cluster that serves as the primary for this replication group.
|
CreateReplicationGroupRequest |
withReplicasPerNodeGroup(Integer replicasPerNodeGroup)
An optional parameter that specifies the number of replica nodes in each node group (shard).
|
CreateReplicationGroupRequest |
withReplicationGroupDescription(String replicationGroupDescription)
A user-created description for the replication group.
|
CreateReplicationGroupRequest |
withReplicationGroupId(String replicationGroupId)
The replication group identifier.
|
CreateReplicationGroupRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
One or more Amazon VPC security groups associated with this replication group.
|
CreateReplicationGroupRequest |
withSecurityGroupIds(String... securityGroupIds)
One or more Amazon VPC security groups associated with this replication group.
|
CreateReplicationGroupRequest |
withSnapshotArns(Collection<String> snapshotArns)
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
|
CreateReplicationGroupRequest |
withSnapshotArns(String... snapshotArns)
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
|
CreateReplicationGroupRequest |
withSnapshotName(String snapshotName)
The name of a snapshot from which to restore data into the new replication group.
|
CreateReplicationGroupRequest |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
CreateReplicationGroupRequest |
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
CreateReplicationGroupRequest |
withTags(Collection<Tag> tags)
A list of tags to be added to this resource.
|
CreateReplicationGroupRequest |
withTags(Tag... tags)
A list of tags to be added to this resource.
|
CreateReplicationGroupRequest |
withTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
A flag that enables in-transit encryption when set to
true . |
CreateReplicationGroupRequest |
withUserGroupIds(Collection<String> userGroupIds)
The user group to associate with the replication group.
|
CreateReplicationGroupRequest |
withUserGroupIds(String... userGroupIds)
The user group to associate with the replication group.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setReplicationGroupId(String replicationGroupId)
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 40 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
replicationGroupId
- The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 40 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
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.
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.
public CreateReplicationGroupRequest withReplicationGroupId(String replicationGroupId)
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 40 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
replicationGroupId
- The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 40 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
public void setReplicationGroupDescription(String replicationGroupDescription)
A user-created description for the replication group.
replicationGroupDescription
- A user-created description for the replication group.public String getReplicationGroupDescription()
A user-created description for the replication group.
public CreateReplicationGroupRequest withReplicationGroupDescription(String replicationGroupDescription)
A user-created description for the replication group.
replicationGroupDescription
- A user-created description for the replication group.public void setGlobalReplicationGroupId(String globalReplicationGroupId)
The name of the Global datastore
globalReplicationGroupId
- The name of the Global datastorepublic String getGlobalReplicationGroupId()
The name of the Global datastore
public CreateReplicationGroupRequest withGlobalReplicationGroupId(String globalReplicationGroupId)
The name of the Global datastore
globalReplicationGroupId
- The name of the Global datastorepublic void setPrimaryClusterId(String primaryClusterId)
The identifier of the cluster that serves as the primary for this replication group. This cluster must already
exist and have a status of available
.
This parameter is not required if NumCacheClusters
, NumNodeGroups
, or
ReplicasPerNodeGroup
is specified.
primaryClusterId
- The identifier of the cluster that serves as the primary for this replication group. This cluster must
already exist and have a status of available
.
This parameter is not required if NumCacheClusters
, NumNodeGroups
, or
ReplicasPerNodeGroup
is specified.
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.
available
.
This parameter is not required if NumCacheClusters
, NumNodeGroups
, or
ReplicasPerNodeGroup
is specified.
public CreateReplicationGroupRequest withPrimaryClusterId(String primaryClusterId)
The identifier of the cluster that serves as the primary for this replication group. This cluster must already
exist and have a status of available
.
This parameter is not required if NumCacheClusters
, NumNodeGroups
, or
ReplicasPerNodeGroup
is specified.
primaryClusterId
- The identifier of the cluster that serves as the primary for this replication group. This cluster must
already exist and have a status of available
.
This parameter is not required if NumCacheClusters
, NumNodeGroups
, or
ReplicasPerNodeGroup
is specified.
public void setAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
automaticFailoverEnabled
- 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
public Boolean 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
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication
groups.
Default: false
public CreateReplicationGroupRequest withAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
automaticFailoverEnabled
- 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
public Boolean isAutomaticFailoverEnabled()
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
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication
groups.
Default: false
public void setMultiAZEnabled(Boolean multiAZEnabled)
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
multiAZEnabled
- A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime:
Multi-AZ.public Boolean getMultiAZEnabled()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
public CreateReplicationGroupRequest withMultiAZEnabled(Boolean multiAZEnabled)
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
multiAZEnabled
- A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime:
Multi-AZ.public Boolean isMultiAZEnabled()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
public void setNumCacheClusters(Integer numCacheClusters)
The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard). You should use
ReplicasPerNodeGroup
instead.
If AutomaticFailoverEnabled
is true
, the value of this parameter must be at least 2. If
AutomaticFailoverEnabled
is false
you can omit this parameter (it will default to 1),
or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters
is 6 (1 primary plus 5 replicas).
numCacheClusters
- The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard). You should use
ReplicasPerNodeGroup
instead.
If AutomaticFailoverEnabled
is true
, the value of this parameter must be at
least 2. If AutomaticFailoverEnabled
is false
you can omit this parameter (it
will default to 1), or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters
is 6 (1 primary plus 5 replicas).
public Integer 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).
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 CreateReplicationGroupRequest withNumCacheClusters(Integer numCacheClusters)
The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard). You should use
ReplicasPerNodeGroup
instead.
If AutomaticFailoverEnabled
is true
, the value of this parameter must be at least 2. If
AutomaticFailoverEnabled
is false
you can omit this parameter (it will default to 1),
or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters
is 6 (1 primary plus 5 replicas).
numCacheClusters
- The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard). You should use
ReplicasPerNodeGroup
instead.
If AutomaticFailoverEnabled
is true
, the value of this parameter must be at
least 2. If AutomaticFailoverEnabled
is false
you can omit this parameter (it
will default to 1), or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters
is 6 (1 primary plus 5 replicas).
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.
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(Collection<String> preferredCacheClusterAZs)
A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use
NodeGroupConfiguration
instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters
.
Default: system chosen Availability Zones.
preferredCacheClusterAZs
- A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the
Availability Zones in the list is the order in which clusters are allocated. The primary cluster is
created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use
NodeGroupConfiguration
instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters
.
Default: system chosen Availability Zones.
public CreateReplicationGroupRequest withPreferredCacheClusterAZs(String... preferredCacheClusterAZs)
A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use
NodeGroupConfiguration
instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters
.
Default: system chosen Availability Zones.
NOTE: This method appends the values to the existing list (if any). Use
setPreferredCacheClusterAZs(java.util.Collection)
or
withPreferredCacheClusterAZs(java.util.Collection)
if you want to override the existing values.
preferredCacheClusterAZs
- A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the
Availability Zones in the list is the order in which clusters are allocated. The primary cluster is
created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use
NodeGroupConfiguration
instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters
.
Default: system chosen Availability Zones.
public CreateReplicationGroupRequest withPreferredCacheClusterAZs(Collection<String> preferredCacheClusterAZs)
A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use
NodeGroupConfiguration
instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters
.
Default: system chosen Availability Zones.
preferredCacheClusterAZs
- A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the
Availability Zones in the list is the order in which clusters are allocated. The primary cluster is
created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use
NodeGroupConfiguration
instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters
.
Default: system chosen Availability Zones.
public void setNumNodeGroups(Integer numNodeGroups)
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.
Default: 1
numNodeGroups
- 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.
Default: 1
public Integer 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.
Default: 1
Default: 1
public CreateReplicationGroupRequest withNumNodeGroups(Integer numNodeGroups)
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.
Default: 1
numNodeGroups
- 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.
Default: 1
public void setReplicasPerNodeGroup(Integer replicasPerNodeGroup)
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
replicasPerNodeGroup
- An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values
are 0 to 5.public Integer getReplicasPerNodeGroup()
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
public CreateReplicationGroupRequest withReplicasPerNodeGroup(Integer replicasPerNodeGroup)
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
replicasPerNodeGroup
- An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values
are 0 to 5.public List<NodeGroupConfiguration> getNodeGroupConfiguration()
A list of node group (shard) configuration options. Each node group (shard) configuration has the following
members: PrimaryAvailabilityZone
, ReplicaAvailabilityZones
, ReplicaCount
,
and Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
PrimaryAvailabilityZone
, ReplicaAvailabilityZones
,
ReplicaCount
, and Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
public void setNodeGroupConfiguration(Collection<NodeGroupConfiguration> nodeGroupConfiguration)
A list of node group (shard) configuration options. Each node group (shard) configuration has the following
members: PrimaryAvailabilityZone
, ReplicaAvailabilityZones
, ReplicaCount
,
and Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
nodeGroupConfiguration
- A list of node group (shard) configuration options. Each node group (shard) configuration has the
following members: PrimaryAvailabilityZone
, ReplicaAvailabilityZones
,
ReplicaCount
, and Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
public CreateReplicationGroupRequest withNodeGroupConfiguration(NodeGroupConfiguration... nodeGroupConfiguration)
A list of node group (shard) configuration options. Each node group (shard) configuration has the following
members: PrimaryAvailabilityZone
, ReplicaAvailabilityZones
, ReplicaCount
,
and Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
NOTE: This method appends the values to the existing list (if any). Use
setNodeGroupConfiguration(java.util.Collection)
or
withNodeGroupConfiguration(java.util.Collection)
if you want to override the existing values.
nodeGroupConfiguration
- A list of node group (shard) configuration options. Each node group (shard) configuration has the
following members: PrimaryAvailabilityZone
, ReplicaAvailabilityZones
,
ReplicaCount
, and Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
public CreateReplicationGroupRequest withNodeGroupConfiguration(Collection<NodeGroupConfiguration> nodeGroupConfiguration)
A list of node group (shard) configuration options. Each node group (shard) configuration has the following
members: PrimaryAvailabilityZone
, ReplicaAvailabilityZones
, ReplicaCount
,
and Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
nodeGroupConfiguration
- A list of node group (shard) configuration options. Each node group (shard) configuration has the
following members: PrimaryAvailabilityZone
, ReplicaAvailabilityZones
,
ReplicaCount
, and Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
public void setCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
,
cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
,
cache.m6g.16xlarge
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
,
cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis
version 2.8.22 and later.
cacheNodeType
- The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
,
cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
,
cache.m6g.16xlarge
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
,
cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on
Redis version 2.8.22 and later.
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 (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
,
cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
,
cache.m6g.16xlarge
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
,
cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis
version 2.8.22 and later.
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 (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
,
cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
,
cache.m6g.16xlarge
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
,
cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on
Redis version 2.8.22 and later.
public CreateReplicationGroupRequest withCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
,
cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
,
cache.m6g.16xlarge
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
,
cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on Redis
version 2.8.22 and later.
cacheNodeType
- The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large
, cache.m6g.xlarge
, cache.m6g.2xlarge
,
cache.m6g.4xlarge
, cache.m6g.8xlarge
, cache.m6g.12xlarge
,
cache.m6g.16xlarge
For region availability, see Supported Node Types
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
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:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
, cache.r6g.xlarge
, cache.r6g.2xlarge
,
cache.r6g.4xlarge
, cache.r6g.8xlarge
, cache.r6g.12xlarge
,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly
and appendfsync
are not supported on
Redis version 2.8.22 and later.
public void setEngine(String engine)
The name of the cache engine to be used for the clusters in this replication group. Must be Redis.
engine
- The name of the cache engine to be used for the clusters in this replication group. Must be Redis.public String getEngine()
The name of the cache engine to be used for the clusters in this replication group. Must be Redis.
public CreateReplicationGroupRequest withEngine(String engine)
The name of the cache engine to be used for the clusters in this replication group. Must be Redis.
engine
- The name of the cache engine to be used for the clusters in this replication group. Must be Redis.public void setEngineVersion(String engineVersion)
The version number of the cache engine to be used for the clusters in this replication group. To view the
supported cache engine versions, use the DescribeCacheEngineVersions
operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
engineVersion
- The version number of the cache engine to be used for the clusters in this replication group. To view the
supported cache engine versions, use the DescribeCacheEngineVersions
operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
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.
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 CreateReplicationGroupRequest withEngineVersion(String engineVersion)
The version number of the cache engine to be used for the clusters in this replication group. To view the
supported cache engine versions, use the DescribeCacheEngineVersions
operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
engineVersion
- The version number of the cache engine to be used for the clusters in this replication group. To view the
supported cache engine versions, use the DescribeCacheEngineVersions
operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
public void setCacheParameterGroupName(String cacheParameterGroupName)
The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
If you are running 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
.
cacheParameterGroupName
- The name of the parameter group to associate with this replication group. If this argument is omitted, the
default cache parameter group for the specified engine is used.
If you are running 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
.
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
.
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
.
public CreateReplicationGroupRequest withCacheParameterGroupName(String cacheParameterGroupName)
The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
If you are running 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
.
cacheParameterGroupName
- The name of the parameter group to associate with this replication group. If this argument is omitted, the
default cache parameter group for the specified engine is used.
If you are running 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
.
public void setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group to be used for the replication group.
If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
cacheSubnetGroupName
- The name of the cache subnet group to be used for the replication group. If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
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 Subnets and Subnet Groups.
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 Subnets and Subnet Groups.
public CreateReplicationGroupRequest withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group to be used for the replication group.
If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
cacheSubnetGroupName
- The name of the cache subnet group to be used for the replication group. If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
public List<String> getCacheSecurityGroupNames()
A list of cache security group names to associate with this replication group.
public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to associate with this replication group.
cacheSecurityGroupNames
- A list of cache security group names to associate with this replication group.public CreateReplicationGroupRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of cache security group names to associate with this replication group.
NOTE: This method appends the values to the existing list (if any). Use
setCacheSecurityGroupNames(java.util.Collection)
or
withCacheSecurityGroupNames(java.util.Collection)
if you want to override the existing values.
cacheSecurityGroupNames
- A list of cache security group names to associate with this replication group.public CreateReplicationGroupRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to associate with this replication group.
cacheSecurityGroupNames
- A list of cache security group names to associate with this replication group.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).
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
public void setSecurityGroupIds(Collection<String> securityGroupIds)
One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
securityGroupIds
- One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
public CreateReplicationGroupRequest withSecurityGroupIds(String... securityGroupIds)
One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroupIds(java.util.Collection)
or withSecurityGroupIds(java.util.Collection)
if you
want to override the existing values.
securityGroupIds
- One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
public CreateReplicationGroupRequest withSecurityGroupIds(Collection<String> securityGroupIds)
One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
securityGroupIds
- One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
public List<Tag> 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.
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 void setTags(Collection<Tag> tags)
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=
myKey
, Value=myKeyValue
. You can include multiple tags as shown following: Key=
myKey
, Value=myKeyValue
Key=mySecondKey
, Value=
mySecondKeyValue
. Tags on replication groups will be replicated to all nodes.
tags
- A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=
myKey
, Value=myKeyValue
. You can include multiple tags as shown following: Key=
myKey
, Value=myKeyValue
Key=mySecondKey
, Value=
mySecondKeyValue
. Tags on replication groups will be replicated to all nodes.public CreateReplicationGroupRequest withTags(Tag... tags)
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=
myKey
, Value=myKeyValue
. You can include multiple tags as shown following: Key=
myKey
, Value=myKeyValue
Key=mySecondKey
, Value=
mySecondKeyValue
. Tags on replication groups will be replicated to all nodes.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=
myKey
, Value=myKeyValue
. You can include multiple tags as shown following: Key=
myKey
, Value=myKeyValue
Key=mySecondKey
, Value=
mySecondKeyValue
. Tags on replication groups will be replicated to all nodes.public CreateReplicationGroupRequest withTags(Collection<Tag> tags)
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=
myKey
, Value=myKeyValue
. You can include multiple tags as shown following: Key=
myKey
, Value=myKeyValue
Key=mySecondKey
, Value=
mySecondKeyValue
. Tags on replication groups will be replicated to all nodes.
tags
- A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=
myKey
, Value=myKeyValue
. You can include multiple tags as shown following: Key=
myKey
, Value=myKeyValue
Key=mySecondKey
, Value=
mySecondKeyValue
. Tags on replication groups will be replicated to all nodes.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
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
public void setSnapshotArns(Collection<String> snapshotArns)
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
snapshotArns
- 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
public CreateReplicationGroupRequest withSnapshotArns(String... snapshotArns)
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
NOTE: This method appends the values to the existing list (if any). Use
setSnapshotArns(java.util.Collection)
or withSnapshotArns(java.util.Collection)
if you want to
override the existing values.
snapshotArns
- 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
public CreateReplicationGroupRequest withSnapshotArns(Collection<String> snapshotArns)
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
snapshotArns
- 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
public void setSnapshotName(String snapshotName)
The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to
restoring
while the new replication group is being created.
snapshotName
- The name of a snapshot from which to restore data into the new replication group. The snapshot status
changes to restoring
while the new replication group is being created.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.
restoring
while the new replication group is being created.public CreateReplicationGroupRequest withSnapshotName(String snapshotName)
The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to
restoring
while the new replication group is being created.
snapshotName
- The name of a snapshot from which to restore data into the new replication group. The snapshot status
changes to restoring
while the new replication group is being created.public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range
in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd
are:
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
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a
range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute
period. Valid values for ddd
are:
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
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:
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
ddd
are:
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
public CreateReplicationGroupRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range
in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd
are:
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
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a
range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute
period. Valid values for ddd
are:
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
public void setPort(Integer port)
The port number on which each member of the replication group accepts connections.
port
- The port number on which each member of the replication group accepts connections.public Integer getPort()
The port number on which each member of the replication group accepts connections.
public CreateReplicationGroupRequest withPort(Integer port)
The port number on which each member of the replication group accepts connections.
port
- The port number on which each member of the replication group accepts connections.public void setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which
notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner.
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.
The Amazon SNS topic owner must be the same as the cluster owner.
public CreateReplicationGroupRequest withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which
notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean getAutoMinorVersionUpgrade()
This parameter is currently disabled.
public CreateReplicationGroupRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean isAutoMinorVersionUpgrade()
This parameter is currently disabled.
public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you
set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being
deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
snapshotRetentionLimit
- The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if
you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days
before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
public Integer 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).
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 CreateReplicationGroupRequest withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you
set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being
deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
snapshotRetentionLimit
- The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if
you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days
before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
public void setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
snapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group
(shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
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.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
public CreateReplicationGroupRequest withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
snapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group
(shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
public void setAuthToken(String authToken)
Reserved parameter. The password used to access a password protected server.
AuthToken
can be specified only on replication groups where TransitEncryptionEnabled
is
true
.
For 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.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
authToken
- Reserved parameter. The password used to access a password protected server.
AuthToken
can be specified only on replication groups where
TransitEncryptionEnabled
is true
.
For 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.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
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 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.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
AuthToken
can be specified only on replication groups where
TransitEncryptionEnabled
is true
.
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.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
public CreateReplicationGroupRequest withAuthToken(String authToken)
Reserved parameter. The password used to access a password protected server.
AuthToken
can be specified only on replication groups where TransitEncryptionEnabled
is
true
.
For 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.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
authToken
- Reserved parameter. The password used to access a password protected server.
AuthToken
can be specified only on replication groups where
TransitEncryptionEnabled
is true
.
For 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.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
public void setTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
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
, 4.x
or later, 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
, 4.x
or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, an
AuthToken
, and a CacheSubnetGroup
.
transitEncryptionEnabled
- 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
, 4.x
or later, 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
, 4.x
or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, an
AuthToken
, and a CacheSubnetGroup
.
public Boolean 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
, 4.x
or later, 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
, 4.x
or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, an
AuthToken
, and a CacheSubnetGroup
.
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
, 4.x
or later, 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
, 4.x
or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, an
AuthToken
, and a CacheSubnetGroup
.
public CreateReplicationGroupRequest withTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
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
, 4.x
or later, 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
, 4.x
or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, an
AuthToken
, and a CacheSubnetGroup
.
transitEncryptionEnabled
- 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
, 4.x
or later, 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
, 4.x
or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, an
AuthToken
, and a CacheSubnetGroup
.
public Boolean isTransitEncryptionEnabled()
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
, 4.x
or later, 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
, 4.x
or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, an
AuthToken
, and a CacheSubnetGroup
.
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
, 4.x
or later, 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
, 4.x
or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, an
AuthToken
, and a CacheSubnetGroup
.
public void setAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
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
, 4.x
or later.
Default: false
atRestEncryptionEnabled
- 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
, 4.x
or later.
Default: false
public Boolean 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
, 4.x
or later.
Default: false
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
, 4.x
or later.
Default: false
public CreateReplicationGroupRequest withAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
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
, 4.x
or later.
Default: false
atRestEncryptionEnabled
- 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
, 4.x
or later.
Default: false
public Boolean isAtRestEncryptionEnabled()
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
, 4.x
or later.
Default: false
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
, 4.x
or later.
Default: false
public void setKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the disk in the cluster.
kmsKeyId
- The ID of the KMS key used to encrypt the disk in the cluster.public String getKmsKeyId()
The ID of the KMS key used to encrypt the disk in the cluster.
public CreateReplicationGroupRequest withKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the disk in the cluster.
kmsKeyId
- The ID of the KMS key used to encrypt the disk in the cluster.public List<String> getUserGroupIds()
The user group to associate with the replication group.
public void setUserGroupIds(Collection<String> userGroupIds)
The user group to associate with the replication group.
userGroupIds
- The user group to associate with the replication group.public CreateReplicationGroupRequest withUserGroupIds(String... userGroupIds)
The user group to associate with the replication group.
NOTE: This method appends the values to the existing list (if any). Use
setUserGroupIds(java.util.Collection)
or withUserGroupIds(java.util.Collection)
if you want to
override the existing values.
userGroupIds
- The user group to associate with the replication group.public CreateReplicationGroupRequest withUserGroupIds(Collection<String> userGroupIds)
The user group to associate with the replication group.
userGroupIds
- The user group to associate with the replication group.public List<LogDeliveryConfigurationRequest> getLogDeliveryConfigurations()
Specifies the destination, format and type of the logs.
public void setLogDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
logDeliveryConfigurations
- Specifies the destination, format and type of the logs.public CreateReplicationGroupRequest withLogDeliveryConfigurations(LogDeliveryConfigurationRequest... logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
NOTE: This method appends the values to the existing list (if any). Use
setLogDeliveryConfigurations(java.util.Collection)
or
withLogDeliveryConfigurations(java.util.Collection)
if you want to override the existing values.
logDeliveryConfigurations
- Specifies the destination, format and type of the logs.public CreateReplicationGroupRequest withLogDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
logDeliveryConfigurations
- Specifies the destination, format and type of the logs.public String toString()
toString
in class Object
Object.toString()
public CreateReplicationGroupRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2021. All rights reserved.