public class CreateReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateReplicationGroup operation
.
The CreateReplicationGroup action creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas.
When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.
Note: This action is valid only for Redis.
NOOP
Constructor and Description |
---|
CreateReplicationGroupRequest() |
Modifier and Type | Method and Description |
---|---|
CreateReplicationGroupRequest |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAutomaticFailoverEnabled()
Specifies whether a read-only replica will be 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.
|
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.
|
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent.
|
Integer |
getNumCacheClusters()
The number of cache clusters this replication group will initially
have.
|
Integer |
getPort()
The port number on which each member of the replication group will
accept connections.
|
List<String> |
getPreferredCacheClusterAZs()
A list of EC2 availability zones in which the replication group's
cache clusters will be 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 will serve as the primary for
this replication group.
|
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 single-element string list containing an Amazon Resource Name (ARN)
that uniquely identifies a Redis RDB snapshot file stored in Amazon
S3.
|
String |
getSnapshotName()
The name of a snapshot from which to restore data into the new node
group.
|
Integer |
getSnapshotRetentionLimit()
The number of days for which ElastiCache will retain automatic
snapshots before deleting them.
|
String |
getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your node group.
|
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 will be automatically promoted
to read/write primary if the existing primary fails.
|
Boolean |
isAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
void |
setAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Specifies whether a read-only replica will be 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.
|
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 |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent.
|
void |
setNumCacheClusters(Integer numCacheClusters)
The number of cache clusters this replication group will initially
have.
|
void |
setPort(Integer port)
The port number on which each member of the replication group will
accept connections.
|
void |
setPreferredCacheClusterAZs(Collection<String> preferredCacheClusterAZs)
A list of EC2 availability zones in which the replication group's
cache clusters will be 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 will serve as the primary for
this replication group.
|
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 single-element string list containing an Amazon Resource Name (ARN)
that uniquely identifies a Redis RDB snapshot file stored in Amazon
S3.
|
void |
setSnapshotName(String snapshotName)
The name of a snapshot from which to restore data into the new node
group.
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic
snapshots before deleting them.
|
void |
setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your node group.
|
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 |
withAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Specifies whether a read-only replica will be 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.
|
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 |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent.
|
CreateReplicationGroupRequest |
withNumCacheClusters(Integer numCacheClusters)
The number of cache clusters this replication group will initially
have.
|
CreateReplicationGroupRequest |
withPort(Integer port)
The port number on which each member of the replication group will
accept connections.
|
CreateReplicationGroupRequest |
withPreferredCacheClusterAZs(Collection<String> preferredCacheClusterAZs)
A list of EC2 availability zones in which the replication group's
cache clusters will be created.
|
CreateReplicationGroupRequest |
withPreferredCacheClusterAZs(String... preferredCacheClusterAZs)
A list of EC2 availability zones in which the replication group's
cache clusters will be 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 will serve as the primary for
this replication group.
|
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 single-element string list containing an Amazon Resource Name (ARN)
that uniquely identifies a Redis RDB snapshot file stored in Amazon
S3.
|
CreateReplicationGroupRequest |
withSnapshotArns(String... snapshotArns)
A single-element string list containing an Amazon Resource Name (ARN)
that uniquely identifies a Redis RDB snapshot file stored in Amazon
S3.
|
CreateReplicationGroupRequest |
withSnapshotName(String snapshotName)
The name of a snapshot from which to restore data into the new node
group.
|
CreateReplicationGroupRequest |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic
snapshots before deleting them.
|
CreateReplicationGroupRequest |
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your node group.
|
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.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public String getReplicationGroupId()
Constraints:
Constraints:
public void setReplicationGroupId(String replicationGroupId)
Constraints:
replicationGroupId
- The replication group identifier. This parameter is stored as a
lowercase string. Constraints:
public CreateReplicationGroupRequest withReplicationGroupId(String replicationGroupId)
Constraints:
Returns a reference to this object so that method calls can be chained together.
replicationGroupId
- The replication group identifier. This parameter is stored as a
lowercase string. Constraints:
public String getReplicationGroupDescription()
public void setReplicationGroupDescription(String replicationGroupDescription)
replicationGroupDescription
- A user-created description for the replication group.public CreateReplicationGroupRequest withReplicationGroupDescription(String replicationGroupDescription)
Returns a reference to this object so that method calls can be chained together.
replicationGroupDescription
- A user-created description for the replication group.public String getPrimaryClusterId()
This parameter is not required if NumCacheClusters is specified.
This parameter is not required if NumCacheClusters is specified.
public void setPrimaryClusterId(String primaryClusterId)
This parameter is not required if NumCacheClusters is specified.
primaryClusterId
- The identifier of the cache cluster that will serve 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 is specified.
public CreateReplicationGroupRequest withPrimaryClusterId(String primaryClusterId)
This parameter is not required if NumCacheClusters is specified.
Returns a reference to this object so that method calls can be chained together.
primaryClusterId
- The identifier of the cache cluster that will serve 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 is specified.
public Boolean isAutomaticFailoverEnabled()
If
true
, Multi-AZ is enabled for this replication group. If
false
, Multi-AZ is disabled for this replication group.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
If
true
, Multi-AZ is enabled for this replication group. If
false
, Multi-AZ is disabled for this replication group.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
public void setAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
If
true
, Multi-AZ is enabled for this replication group. If
false
, Multi-AZ is disabled for this replication group.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
automaticFailoverEnabled
- Specifies whether a read-only replica will be 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.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
public CreateReplicationGroupRequest withAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
If
true
, Multi-AZ is enabled for this replication group. If
false
, Multi-AZ is disabled for this replication group.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
Returns a reference to this object so that method calls can be chained together.
automaticFailoverEnabled
- Specifies whether a read-only replica will be 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.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
public Boolean getAutomaticFailoverEnabled()
If
true
, Multi-AZ is enabled for this replication group. If
false
, Multi-AZ is disabled for this replication group.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
If
true
, Multi-AZ is enabled for this replication group. If
false
, Multi-AZ is disabled for this replication group.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
public Integer getNumCacheClusters()
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). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
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). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
public void setNumCacheClusters(Integer numCacheClusters)
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). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
numCacheClusters
- The number of cache clusters this replication group will initially
have. 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). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
public CreateReplicationGroupRequest withNumCacheClusters(Integer numCacheClusters)
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). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
Returns a reference to this object so that method calls can be chained together.
numCacheClusters
- The number of cache clusters this replication group will initially
have. 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). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
public List<String> getPreferredCacheClusterAZs()
The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
public void setPreferredCacheClusterAZs(Collection<String> preferredCacheClusterAZs)
The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
preferredCacheClusterAZs
- A list of EC2 availability zones in which the replication group's
cache clusters will be created. The order of the availability zones in
the list is not important. The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
public CreateReplicationGroupRequest withPreferredCacheClusterAZs(String... preferredCacheClusterAZs)
The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
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.
Returns a reference to this object so that method calls can be chained together.
preferredCacheClusterAZs
- A list of EC2 availability zones in which the replication group's
cache clusters will be created. The order of the availability zones in
the list is not important. The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
public CreateReplicationGroupRequest withPreferredCacheClusterAZs(Collection<String> preferredCacheClusterAZs)
The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
Returns a reference to this object so that method calls can be chained together.
preferredCacheClusterAZs
- A list of EC2 availability zones in which the replication group's
cache clusters will be created. The order of the availability zones in
the list is not important. The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
public String getCacheNodeType()
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public void setCacheNodeType(String cacheNodeType)
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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.
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public CreateReplicationGroupRequest withCacheNodeType(String cacheNodeType)
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Returns a reference to this object so that method calls can be chained together.
cacheNodeType
- The compute and memory capacity of the nodes in the node group.
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
cache.c1.xlarge
cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
,
cache.r3.8xlarge
cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public String getEngine()
Default: redis
Default: redis
public void setEngine(String engine)
Default: redis
engine
- The name of the cache engine to be used for the cache clusters in this
replication group. Default: redis
public CreateReplicationGroupRequest withEngine(String engine)
Default: redis
Returns a reference to this object so that method calls can be chained together.
engine
- The name of the cache engine to be used for the cache clusters in this
replication group. Default: redis
public String getEngineVersion()
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), 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.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), 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 setEngineVersion(String engineVersion)
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), 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 action.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), 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)
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), 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.
Returns a reference to this object so that method calls can be chained together.
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 action.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), 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 getCacheParameterGroupName()
public void setCacheParameterGroupName(String cacheParameterGroupName)
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.public CreateReplicationGroupRequest withCacheParameterGroupName(String cacheParameterGroupName)
Returns a reference to this object so that method calls can be chained together.
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.public String getCacheSubnetGroupName()
public void setCacheSubnetGroupName(String cacheSubnetGroupName)
cacheSubnetGroupName
- The name of the cache subnet group to be used for the replication
group.public CreateReplicationGroupRequest withCacheSubnetGroupName(String cacheSubnetGroupName)
Returns a reference to this object so that method calls can be chained together.
cacheSubnetGroupName
- The name of the cache subnet group to be used for the replication
group.public List<String> getCacheSecurityGroupNames()
public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
cacheSecurityGroupNames
- A list of cache security group names to associate with this
replication group.public CreateReplicationGroupRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
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.
Returns a reference to this object so that method calls can be chained together.
cacheSecurityGroupNames
- A list of cache security group names to associate with this
replication group.public CreateReplicationGroupRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
Returns a reference to this object so that method calls can be chained together.
cacheSecurityGroupNames
- A list of cache security group names to associate with this
replication group.public List<String> getSecurityGroupIds()
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).
public void setSecurityGroupIds(Collection<String> securityGroupIds)
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (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 (VPC).
public CreateReplicationGroupRequest withSecurityGroupIds(String... securityGroupIds)
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (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.
Returns a reference to this object so that method calls can be chained together.
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 (VPC).
public CreateReplicationGroupRequest withSecurityGroupIds(Collection<String> securityGroupIds)
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
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 (VPC).
public List<Tag> getTags()
public void setTags(Collection<Tag> tags)
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)
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.
Returns a reference to this object so that method calls can be chained together.
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)
Returns a reference to this object so that method calls can be chained together.
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()
Note: 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 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)
Note: 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 single-element string list containing an Amazon Resource Name (ARN)
that uniquely identifies a Redis RDB snapshot file stored in Amazon
S3. The snapshot file will be used to populate the node group. The
Amazon S3 object name in the ARN cannot contain any commas.
Note: 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)
Note: 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.
Returns a reference to this object so that method calls can be chained together.
snapshotArns
- A single-element string list containing an Amazon Resource Name (ARN)
that uniquely identifies a Redis RDB snapshot file stored in Amazon
S3. The snapshot file will be used to populate the node group. The
Amazon S3 object name in the ARN cannot contain any commas.
Note: 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)
Note: This parameter is only valid if the
Engine
parameter is redis
.
Example of an
Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
Returns a reference to this object so that method calls can be chained together.
snapshotArns
- A single-element string list containing an Amazon Resource Name (ARN)
that uniquely identifies a Redis RDB snapshot file stored in Amazon
S3. The snapshot file will be used to populate the node group. The
Amazon S3 object name in the ARN cannot contain any commas.
Note: 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 String getSnapshotName()
restoring
while the
new node group is being created. Note: This parameter is
only valid if the Engine
parameter is redis
.
restoring
while the
new node group is being created. Note: This parameter is
only valid if the Engine
parameter is redis
.
public void setSnapshotName(String snapshotName)
restoring
while the
new node group is being created. Note: 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 node
group. The snapshot status changes to restoring
while the
new node group is being created. Note: This parameter is
only valid if the Engine
parameter is redis
.
public CreateReplicationGroupRequest withSnapshotName(String snapshotName)
restoring
while the
new node group is being created. Note: This parameter is
only valid if the Engine
parameter is redis
.
Returns a reference to this object so that method calls can be chained together.
snapshotName
- The name of a snapshot from which to restore data into the new node
group. The snapshot status changes to restoring
while the
new node group is being created. Note: This parameter is
only valid if the Engine
parameter is redis
.
public String getPreferredMaintenanceWindow()
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
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:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
public CreateReplicationGroupRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
Returns a reference to this object so that method calls can be chained together.
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:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
public Integer getPort()
public void setPort(Integer port)
port
- The port number on which each member of the replication group will
accept connections.public CreateReplicationGroupRequest withPort(Integer port)
Returns a reference to this object so that method calls can be chained together.
port
- The port number on which each member of the replication group will
accept connections.public String getNotificationTopicArn()
public void setNotificationTopicArn(String notificationTopicArn)
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent. public CreateReplicationGroupRequest withNotificationTopicArn(String notificationTopicArn)
Returns a reference to this object so that method calls can be chained together.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent. public Boolean isAutoMinorVersionUpgrade()
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
autoMinorVersionUpgrade
- This parameter is currently disabled.public CreateReplicationGroupRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean getAutoMinorVersionUpgrade()
public Integer getSnapshotRetentionLimit()
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: 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, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: 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 setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: 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 will retain automatic
snapshots before deleting them. For example, if you set
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: 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)
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the
Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
Returns a reference to this object so that method calls can be chained together.
snapshotRetentionLimit
- The number of days for which ElastiCache will retain automatic
snapshots before deleting them. For example, if you set
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the
Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
public String getSnapshotWindow()
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine
parameter is redis
.
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine
parameter is redis
.
public void setSnapshotWindow(String snapshotWindow)
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine
parameter is redis
.
snapshotWindow
- The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your node group. Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine
parameter is redis
.
public CreateReplicationGroupRequest withSnapshotWindow(String snapshotWindow)
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine
parameter is redis
.
Returns a reference to this object so that method calls can be chained together.
snapshotWindow
- The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your node group. Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine
parameter is redis
.
public String toString()
toString
in class Object
Object.toString()
public CreateReplicationGroupRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2016. All rights reserved.