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()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getAuthToken()
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 cache clusters in this replication group.
|
String |
getEngineVersion()
The version number of the cache engine to be used for the cache clusters in this replication group.
|
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 cache clusters are created.
|
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cache cluster is performed.
|
String |
getPrimaryClusterId()
The identifier of the cache 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 cost allocation tags to be added to this resource.
|
int |
hashCode() |
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.
|
void |
setAuthToken(String authToken)
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 cache clusters in this replication group.
|
void |
setEngineVersion(String engineVersion)
The version number of the cache engine to be used for the cache clusters in this replication group.
|
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 cache clusters are created.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache cluster is performed.
|
void |
setPrimaryClusterId(String primaryClusterId)
The identifier of the cache 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 cost allocation tags to be added to this resource.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
CreateReplicationGroupRequest |
withAuthToken(String authToken)
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 cache clusters in this replication group.
|
CreateReplicationGroupRequest |
withEngineVersion(String engineVersion)
The version number of the cache engine to be used for the cache clusters in this replication group.
|
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 cache clusters are created.
|
CreateReplicationGroupRequest |
withPreferredCacheClusterAZs(String... preferredCacheClusterAZs)
A list of EC2 Availability Zones in which the replication group's cache clusters are created.
|
CreateReplicationGroupRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache cluster is performed.
|
CreateReplicationGroupRequest |
withPrimaryClusterId(String primaryClusterId)
The identifier of the cache 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 cost allocation tags to be added to this resource.
|
CreateReplicationGroupRequest |
withTags(Tag... tags)
A list of cost allocation tags to be added to this resource.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, 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 20 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 20 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 20 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 20 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 20 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 20 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 setPrimaryClusterId(String primaryClusterId)
The identifier of the cache cluster that serves as the primary for this replication group. This cache 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 cache cluster that serves as the primary for this replication group. This cache
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 cache cluster that serves as the primary for this replication group. This cache 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 cache cluster that serves as the primary for this replication group. This cache 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 cache cluster that serves as the primary for this replication group. This cache
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.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is disabled
for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
ElastiCache Multi-AZ replication groups is not supported on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 node types.
Redis (cluster mode enabled): T2 node types.
automaticFailoverEnabled
- Specifies whether a read-only replica is automatically promoted to read/write primary if the existing
primary fails.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is
disabled for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
ElastiCache Multi-AZ replication groups is not supported on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 node types.
Redis (cluster mode enabled): T2 node types.
public Boolean getAutomaticFailoverEnabled()
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is disabled
for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
ElastiCache Multi-AZ replication groups is not supported on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 node types.
Redis (cluster mode enabled): T2 node types.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is
disabled for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication
groups.
Default: false
ElastiCache Multi-AZ replication groups is not supported on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 node types.
Redis (cluster mode enabled): T2 node types.
public CreateReplicationGroupRequest withAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is disabled
for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
ElastiCache Multi-AZ replication groups is not supported on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 node types.
Redis (cluster mode enabled): T2 node types.
automaticFailoverEnabled
- Specifies whether a read-only replica is automatically promoted to read/write primary if the existing
primary fails.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is
disabled for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
ElastiCache Multi-AZ replication groups is not supported on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 node types.
Redis (cluster mode enabled): T2 node types.
public Boolean isAutomaticFailoverEnabled()
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is disabled
for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
ElastiCache Multi-AZ replication groups is not supported on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 node types.
Redis (cluster mode enabled): T2 node types.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is
disabled for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication
groups.
Default: false
ElastiCache Multi-AZ replication groups is not supported on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 node types.
Redis (cluster mode enabled): T2 node types.
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 Multi-AZ
is enabled
, the value of this parameter must be at least 2.
The maximum permitted value for NumCacheClusters
is 6 (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 Multi-AZ
is enabled
, the value of this parameter must be at least 2.
The maximum permitted value for NumCacheClusters
is 6 (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 Multi-AZ
is enabled
, the value of this parameter must be at least 2.
The maximum permitted value for NumCacheClusters
is 6 (primary plus 5 replicas).
This parameter is not used if there is more than one node group (shard). You should use
ReplicasPerNodeGroup
instead.
If Multi-AZ
is enabled
, the value of this parameter must be at least 2.
The maximum permitted value for NumCacheClusters
is 6 (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 Multi-AZ
is enabled
, the value of this parameter must be at least 2.
The maximum permitted value for NumCacheClusters
is 6 (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 Multi-AZ
is enabled
, the value of this parameter must be at least 2.
The maximum permitted value for NumCacheClusters
is 6 (primary plus 5 replicas).
public List<String> getPreferredCacheClusterAZs()
A list of EC2 Availability Zones in which the replication group's cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to configure one node group (shard) or you can omit this parameter.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to configure one node group (shard) or you can omit this parameter.
public void setNodeGroupConfiguration(Collection<NodeGroupConfiguration> nodeGroupConfiguration)
A list of node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to configure one node group (shard) or you can omit this parameter.
nodeGroupConfiguration
- A list of node group (shard) configuration options. Each node group (shard) configuration has the
following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to configure one node group (shard) or you can omit this parameter.
public CreateReplicationGroupRequest withNodeGroupConfiguration(NodeGroupConfiguration... nodeGroupConfiguration)
A list of node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to configure one node group (shard) or you can omit this parameter.
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: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to configure one node group (shard) or you can omit this parameter.
public CreateReplicationGroupRequest withNodeGroupConfiguration(Collection<NodeGroupConfiguration> nodeGroupConfiguration)
A list of node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to configure one node group (shard) or you can omit this parameter.
nodeGroupConfiguration
- A list of node group (shard) configuration options. Each node group (shard) configuration has the
following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to configure one node group (shard) or you can omit this parameter.
public void setCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the node group (shard).
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
, cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
, cache.m4.large
, cache.m4.xlarge
,
cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
Previous generation: cache.t1.micro
, cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
cacheNodeType
- The compute and memory capacity of the nodes in the node group (shard).
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
, cache.t2.small
, cache.t2.medium
, cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
, cache.m4.large
, cache.m4.xlarge
,
cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
Previous generation: cache.t1.micro
, cache.m1.small
,
cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public String getCacheNodeType()
The compute and memory capacity of the nodes in the node group (shard).
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
, cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
, cache.m4.large
, cache.m4.xlarge
,
cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
Previous generation: cache.t1.micro
, cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
, cache.t2.small
,
cache.t2.medium
, cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
, cache.m4.large
,
cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
,
cache.m4.10xlarge
Previous generation: cache.t1.micro
, cache.m1.small
,
cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public CreateReplicationGroupRequest withCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the node group (shard).
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
, cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
, cache.m4.large
, cache.m4.xlarge
,
cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
Previous generation: cache.t1.micro
, cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
cacheNodeType
- The compute and memory capacity of the nodes in the node group (shard).
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
, cache.t2.small
, cache.t2.medium
, cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
, cache.m4.large
, cache.m4.xlarge
,
cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
Previous generation: cache.t1.micro
, cache.m1.small
,
cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public void setEngine(String engine)
The name of the cache engine to be used for the cache clusters in this replication group.
engine
- The name of the cache engine to be used for the cache clusters in this replication group.public String getEngine()
The name of the cache engine to be used for the cache clusters in this replication group.
public CreateReplicationGroupRequest withEngine(String engine)
The name of the cache engine to be used for the cache clusters in this replication group.
engine
- The name of the cache engine to be used for the cache clusters in this replication group.public void setEngineVersion(String engineVersion)
The version number of the cache engine to be used for the cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
public void setTags(Collection<Tag> tags)
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
tags
- A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be
accompanied by a tag value.public CreateReplicationGroupRequest withTags(Tag... tags)
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
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 cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be
accompanied by a tag value.public CreateReplicationGroupRequest withTags(Collection<Tag> tags)
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
tags
- A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be
accompanied by a tag value.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 replication group. The Amazon S3 object name in the ARN cannot contain any commas. The list must match the number of node groups (shards) in the replication group, which means you cannot repartition.
This parameter is only valid if the Engine
parameter is redis
.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
This parameter is only valid if the Engine
parameter is redis
.
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 replication group. The Amazon S3 object name in the ARN cannot contain any commas. The list must match the number of node groups (shards) in the replication group, which means you cannot repartition.
This parameter is only valid if the Engine
parameter is redis
.
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 replication group. The Amazon S3 object name in the ARN
cannot contain any commas. The list must match the number of node groups (shards) in the replication
group, which means you cannot repartition.
This parameter is only valid if the Engine
parameter is redis
.
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 replication group. The Amazon S3 object name in the ARN cannot contain any commas. The list must match the number of node groups (shards) in the replication group, which means you cannot repartition.
This parameter is only valid if the Engine
parameter is redis
.
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 replication group. The Amazon S3 object name in the ARN
cannot contain any commas. The list must match the number of node groups (shards) in the replication
group, which means you cannot repartition.
This parameter is only valid if the Engine
parameter is redis
.
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 replication group. The Amazon S3 object name in the ARN cannot contain any commas. The list must match the number of node groups (shards) in the replication group, which means you cannot repartition.
This parameter is only valid if the Engine
parameter is redis
.
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 replication group. The Amazon S3 object name in the ARN
cannot contain any commas. The list must match the number of node groups (shards) in the replication
group, which means you cannot repartition.
This parameter is only valid if the Engine
parameter is redis
.
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.
This parameter is only valid if the Engine
parameter is redis
.
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.
This parameter is only valid if the Engine
parameter is redis
.
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.
This parameter is only valid if the Engine
parameter is redis
.
restoring
while the new replication group is being created.
This parameter is only valid if the Engine
parameter is redis
.
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.
This parameter is only valid if the Engine
parameter is redis
.
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.
This parameter is only valid if the Engine
parameter is redis
.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache 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 cache cluster owner.
The Amazon SNS topic owner must be the same as the cache 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 cache 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 cache 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.
This parameter is only valid if the Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are disabled for this cache 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.
This parameter is only valid if the Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are disabled for this cache 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.
This parameter is only valid if the Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5
days before being deleted.
This parameter is only valid if the Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are disabled for this cache 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.
This parameter is only valid if the Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are disabled for this cache 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.
This parameter is only valid if the Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are disabled for this cache 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.
This parameter is only valid if the Engine
parameter is redis
.
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.
This parameter is only valid if the Engine
parameter is redis
.
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.
This parameter is only valid if the Engine
parameter is redis
.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the Engine
parameter is redis
.
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.
This parameter is only valid if the Engine
parameter is redis
.
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.
This parameter is only valid if the Engine
parameter is redis
.
public void setAuthToken(String authToken)
The password used to access a password protected server.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
Cannot contain any of the following characters: '/', '"', or "@".
For more information, see AUTH password at Redis.
authToken
- The password used to access a password protected server.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
Cannot contain any of the following characters: '/', '"', or "@".
For more information, see AUTH password at Redis.
public String getAuthToken()
The password used to access a password protected server.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
Cannot contain any of the following characters: '/', '"', or "@".
For more information, see AUTH password at Redis.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
Cannot contain any of the following characters: '/', '"', or "@".
For more information, see AUTH password at Redis.
public CreateReplicationGroupRequest withAuthToken(String authToken)
The password used to access a password protected server.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
Cannot contain any of the following characters: '/', '"', or "@".
For more information, see AUTH password at Redis.
authToken
- The password used to access a password protected server.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
Cannot contain any of the following characters: '/', '"', or "@".
For more information, see AUTH password at Redis.
public String toString()
toString
in class Object
Object.toString()
public CreateReplicationGroupRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.