public class CreateCacheClusterRequest extends AmazonWebServiceRequest implements Serializable
CreateCacheCluster operation
.
The CreateCacheCluster operation creates a new cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software - either Memcached or Redis.
NOOP
Constructor and Description |
---|
CreateCacheClusterRequest()
Default constructor for a new CreateCacheClusterRequest object.
|
CreateCacheClusterRequest(String cacheClusterId,
Integer numCacheNodes,
String cacheNodeType,
String engine,
List<String> cacheSecurityGroupNames)
Constructs a new CreateCacheClusterRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
Boolean |
getAutoMinorVersionUpgrade()
Determines whether minor engine upgrades will be applied automatically
to the cache cluster during the maintenance window.
|
String |
getAZMode()
Specifies whether the nodes in this Memcached cache cluster are
created in a single Availability Zone or created across multiple
Availability Zones.
|
String |
getCacheClusterId()
The cache cluster identifier.
|
String |
getCacheNodeType()
The compute and memory capacity of the nodes in the cache cluster.
|
String |
getCacheParameterGroupName()
The name of the cache parameter group to associate with this cache
cluster.
|
List<String> |
getCacheSecurityGroupNames()
A list of cache security group names to associate with this cache
cluster.
|
String |
getCacheSubnetGroupName()
The name of the cache subnet group to be used for the cache cluster.
|
String |
getEngine()
The name of the cache engine to be used for this cache cluster.
|
String |
getEngineVersion()
The version number of the cache engine to be used for this cluster.
|
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent.
|
Integer |
getNumCacheNodes()
The initial number of cache nodes that the cache cluster will have.
|
Integer |
getPort()
The port number on which each of the cache nodes will accept
connections.
|
String |
getPreferredAvailabilityZone()
The EC2 Availability Zone in which the cache cluster will be created.
|
List<String> |
getPreferredAvailabilityZones()
A list of the Availability Zones in which nodes will be created.
|
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can
occur.
|
String |
getReplicationGroupId()
The replication group to which this cache cluster should belong.
|
List<String> |
getSecurityGroupIds()
One or more VPC security groups associated with the cache cluster.
|
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 cache
cluster.
|
Integer |
getSnapshotRetentionLimit()
The number of days for which ElastiCache will retain automatic cache
cluster snapshots before deleting them.
|
String |
getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Determines whether minor engine upgrades will be applied automatically
to the cache cluster during the maintenance window.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Determines whether minor engine upgrades will be applied automatically
to the cache cluster during the maintenance window.
|
void |
setAZMode(String aZMode)
Specifies whether the nodes in this Memcached cache cluster are
created in a single Availability Zone or created across multiple
Availability Zones.
|
void |
setCacheClusterId(String cacheClusterId)
The cache cluster identifier.
|
void |
setCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the cache cluster.
|
void |
setCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to associate with this cache
cluster.
|
void |
setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to associate with this cache
cluster.
|
void |
setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group to be used for the cache cluster.
|
void |
setEngine(String engine)
The name of the cache engine to be used for this cache cluster.
|
void |
setEngineVersion(String engineVersion)
The version number of the cache engine to be used for this cluster.
|
void |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent.
|
void |
setNumCacheNodes(Integer numCacheNodes)
The initial number of cache nodes that the cache cluster will have.
|
void |
setPort(Integer port)
The port number on which each of the cache nodes will accept
connections.
|
void |
setPreferredAvailabilityZone(String preferredAvailabilityZone)
The EC2 Availability Zone in which the cache cluster will be created.
|
void |
setPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)
A list of the Availability Zones in which nodes will be created.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can
occur.
|
void |
setReplicationGroupId(String replicationGroupId)
The replication group to which this cache cluster should belong.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
One or more VPC security groups associated with the cache cluster.
|
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 cache
cluster.
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic cache
cluster 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 cache cluster.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateCacheClusterRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Determines whether minor engine upgrades will be applied automatically
to the cache cluster during the maintenance window.
|
CreateCacheClusterRequest |
withAZMode(String aZMode)
Specifies whether the nodes in this Memcached cache cluster are
created in a single Availability Zone or created across multiple
Availability Zones.
|
CreateCacheClusterRequest |
withCacheClusterId(String cacheClusterId)
The cache cluster identifier.
|
CreateCacheClusterRequest |
withCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the cache cluster.
|
CreateCacheClusterRequest |
withCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to associate with this cache
cluster.
|
CreateCacheClusterRequest |
withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to associate with this cache
cluster.
|
CreateCacheClusterRequest |
withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of cache security group names to associate with this cache
cluster.
|
CreateCacheClusterRequest |
withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group to be used for the cache cluster.
|
CreateCacheClusterRequest |
withEngine(String engine)
The name of the cache engine to be used for this cache cluster.
|
CreateCacheClusterRequest |
withEngineVersion(String engineVersion)
The version number of the cache engine to be used for this cluster.
|
CreateCacheClusterRequest |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent.
|
CreateCacheClusterRequest |
withNumCacheNodes(Integer numCacheNodes)
The initial number of cache nodes that the cache cluster will have.
|
CreateCacheClusterRequest |
withPort(Integer port)
The port number on which each of the cache nodes will accept
connections.
|
CreateCacheClusterRequest |
withPreferredAvailabilityZone(String preferredAvailabilityZone)
The EC2 Availability Zone in which the cache cluster will be created.
|
CreateCacheClusterRequest |
withPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)
A list of the Availability Zones in which nodes will be created.
|
CreateCacheClusterRequest |
withPreferredAvailabilityZones(String... preferredAvailabilityZones)
A list of the Availability Zones in which nodes will be created.
|
CreateCacheClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can
occur.
|
CreateCacheClusterRequest |
withReplicationGroupId(String replicationGroupId)
The replication group to which this cache cluster should belong.
|
CreateCacheClusterRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
One or more VPC security groups associated with the cache cluster.
|
CreateCacheClusterRequest |
withSecurityGroupIds(String... securityGroupIds)
One or more VPC security groups associated with the cache cluster.
|
CreateCacheClusterRequest |
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.
|
CreateCacheClusterRequest |
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.
|
CreateCacheClusterRequest |
withSnapshotName(String snapshotName)
The name of a snapshot from which to restore data into the new cache
cluster.
|
CreateCacheClusterRequest |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic cache
cluster snapshots before deleting them.
|
CreateCacheClusterRequest |
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster.
|
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public CreateCacheClusterRequest()
public CreateCacheClusterRequest(String cacheClusterId, Integer numCacheNodes, String cacheNodeType, String engine, List<String> cacheSecurityGroupNames)
cacheClusterId
- The cache cluster identifier. This parameter is
stored as a lowercase string. Constraints:
numCacheNodes
- The initial number of cache nodes that the cache
cluster will have. For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
cacheNodeType
- The compute and memory capacity of the nodes in
the cache cluster. Valid cache types
cache.t1.micro | cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge
| cache.m3.2xlarge
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
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
engine
- The name of the cache engine to be used for this cache
cluster. Valid values for this parameter are:
memcached
| redis
cacheSecurityGroupNames
- A list of cache security group names to
associate with this cache cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
public String getCacheClusterId()
Constraints:
Constraints:
public void setCacheClusterId(String cacheClusterId)
Constraints:
cacheClusterId
- The cache cluster identifier. This parameter is stored as a lowercase
string. Constraints:
public CreateCacheClusterRequest withCacheClusterId(String cacheClusterId)
Constraints:
Returns a reference to this object so that method calls can be chained together.
cacheClusterId
- The cache cluster identifier. This parameter is stored as a lowercase
string. Constraints:
public String getReplicationGroupId()
public void setReplicationGroupId(String replicationGroupId)
replicationGroupId
- The replication group to which this cache cluster should belong. If
this parameter is specified, the cache cluster will be added to the
specified replication group as a read replica; otherwise, the cache
cluster will be a standalone primary that is not part of any
replication group.public CreateCacheClusterRequest withReplicationGroupId(String replicationGroupId)
Returns a reference to this object so that method calls can be chained together.
replicationGroupId
- The replication group to which this cache cluster should belong. If
this parameter is specified, the cache cluster will be added to the
specified replication group as a read replica; otherwise, the cache
cluster will be a standalone primary that is not part of any
replication group.public Integer getNumCacheNodes()
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
public void setNumCacheNodes(Integer numCacheNodes)
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
numCacheNodes
- The initial number of cache nodes that the cache cluster will have.
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
public CreateCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
Returns a reference to this object so that method calls can be chained together.
numCacheNodes
- The initial number of cache nodes that the cache cluster will have.
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
public String getCacheNodeType()
Valid cache types
cache.t1.micro |
cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge
| cache.m3.2xlarge
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
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
Valid cache types
cache.t1.micro |
cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge
| cache.m3.2xlarge
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
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
public void setCacheNodeType(String cacheNodeType)
Valid cache types
cache.t1.micro |
cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge
| cache.m3.2xlarge
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
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
cacheNodeType
- The compute and memory capacity of the nodes in the cache cluster.
Valid cache types
cache.t1.micro |
cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge
| cache.m3.2xlarge
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
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
public CreateCacheClusterRequest withCacheNodeType(String cacheNodeType)
Valid cache types
cache.t1.micro |
cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge
| cache.m3.2xlarge
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
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
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 cache cluster.
Valid cache types
cache.t1.micro |
cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge
| cache.m3.2xlarge
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
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
public String getEngine()
Valid values for this parameter are:
memcached
|
redis
Valid values for this parameter are:
memcached
|
redis
public void setEngine(String engine)
Valid values for this parameter are:
memcached
|
redis
engine
- The name of the cache engine to be used for this cache cluster.
Valid values for this parameter are:
memcached
|
redis
public CreateCacheClusterRequest withEngine(String engine)
Valid values for this parameter are:
memcached
|
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 this cache cluster.
Valid values for this parameter are:
memcached
|
redis
public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- The version number of the cache engine to be used for this cluster. To
view the supported cache engine versions, use the
DescribeCacheEngineVersions operation.public CreateCacheClusterRequest withEngineVersion(String engineVersion)
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 this cluster. To
view the supported cache engine versions, use the
DescribeCacheEngineVersions operation.public String getCacheParameterGroupName()
public void setCacheParameterGroupName(String cacheParameterGroupName)
cacheParameterGroupName
- The name of the cache parameter group to associate with this cache
cluster. If this argument is omitted, the default cache parameter
group for the specified engine will be used.public CreateCacheClusterRequest withCacheParameterGroupName(String cacheParameterGroupName)
Returns a reference to this object so that method calls can be chained together.
cacheParameterGroupName
- The name of the cache parameter group to associate with this cache
cluster. If this argument is omitted, the default cache parameter
group for the specified engine will be used.public String getCacheSubnetGroupName()
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public void setCacheSubnetGroupName(String cacheSubnetGroupName)
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
cacheSubnetGroupName
- The name of the cache subnet group to be used for the cache cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withCacheSubnetGroupName(String cacheSubnetGroupName)
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
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 cache cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public List<String> getCacheSecurityGroupNames()
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
cacheSecurityGroupNames
- A list of cache security group names to associate with this cache
cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
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 cache
cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
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 cache
cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
public List<String> getSecurityGroupIds()
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public void setSecurityGroupIds(Collection<String> securityGroupIds)
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
securityGroupIds
- One or more VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withSecurityGroupIds(String... securityGroupIds)
Use this parameter only when you are creating a cluster 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 VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withSecurityGroupIds(Collection<String> securityGroupIds)
Use this parameter only when you are creating a cluster 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 VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public List<String> getSnapshotArns()
Here is an 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
.
Here is an 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
.
public void setSnapshotArns(Collection<String> snapshotArns)
Here is an 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
.
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 Redis cache in the
new cache cluster. The Amazon S3 object name in the ARN cannot contain
any commas. Here is an 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
.
public CreateCacheClusterRequest withSnapshotArns(String... snapshotArns)
Here is an 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
.
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 Redis cache in the
new cache cluster. The Amazon S3 object name in the ARN cannot contain
any commas. Here is an 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
.
public CreateCacheClusterRequest withSnapshotArns(Collection<String> snapshotArns)
Here is an 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
.
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 Redis cache in the
new cache cluster. The Amazon S3 object name in the ARN cannot contain
any commas. Here is an 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
.
public String getSnapshotName()
restoring
while
the new cache cluster is being created.restoring
while
the new cache cluster is being created.public void setSnapshotName(String snapshotName)
restoring
while
the new cache cluster is being created.snapshotName
- The name of a snapshot from which to restore data into the new cache
cluster. The snapshot's status changes to restoring
while
the new cache cluster is being created.public CreateCacheClusterRequest withSnapshotName(String snapshotName)
restoring
while
the new cache cluster is being created.
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 cache
cluster. The snapshot's status changes to restoring
while
the new cache cluster is being created.public String getAZMode()
This option is only supported for Memcached
cache clusters. AZMode
and
PreferredAvailabilityZones
are not specified, ElastiCache
assumes single-az
mode.
Valid values:
single-az
| cross-az
.
This option is only supported for Memcached
cache clusters. AZMode
and
PreferredAvailabilityZones
are not specified, ElastiCache
assumes single-az
mode.
Valid values:
single-az
| cross-az
.
public void setAZMode(String aZMode)
This option is only supported for Memcached
cache clusters. AZMode
and
PreferredAvailabilityZones
are not specified, ElastiCache
assumes single-az
mode.
Valid values:
single-az
| cross-az
.
aZMode
- Specifies whether the nodes in this Memcached cache cluster are
created in a single Availability Zone or created across multiple
Availability Zones. This option is only supported for Memcached
cache clusters. AZMode
and
PreferredAvailabilityZones
are not specified, ElastiCache
assumes single-az
mode.
Valid values:
single-az
| cross-az
.
public CreateCacheClusterRequest withAZMode(String aZMode)
This option is only supported for Memcached
cache clusters. AZMode
and
PreferredAvailabilityZones
are not specified, ElastiCache
assumes single-az
mode.
Valid values:
single-az
| cross-az
.
Returns a reference to this object so that method calls can be chained together.
aZMode
- Specifies whether the nodes in this Memcached cache cluster are
created in a single Availability Zone or created across multiple
Availability Zones. This option is only supported for Memcached
cache clusters. AZMode
and
PreferredAvailabilityZones
are not specified, ElastiCache
assumes single-az
mode.
Valid values:
single-az
| cross-az
.
public String getPreferredAvailabilityZone()
All cache nodes belonging to this Memcached cache cluster are
placed in the preferred Availability Zone. If you want to create your
cache nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
All cache nodes belonging to this Memcached cache cluster are
placed in the preferred Availability Zone. If you want to create your
cache nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
public void setPreferredAvailabilityZone(String preferredAvailabilityZone)
All cache nodes belonging to this Memcached cache cluster are
placed in the preferred Availability Zone. If you want to create your
cache nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
preferredAvailabilityZone
- The EC2 Availability Zone in which the cache cluster will be created.
All cache nodes belonging to this Memcached cache cluster are
placed in the preferred Availability Zone. If you want to create your
cache nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
public CreateCacheClusterRequest withPreferredAvailabilityZone(String preferredAvailabilityZone)
All cache nodes belonging to this Memcached cache cluster are
placed in the preferred Availability Zone. If you want to create your
cache nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
Returns a reference to this object so that method calls can be chained together.
preferredAvailabilityZone
- The EC2 Availability Zone in which the cache cluster will be created.
All cache nodes belonging to this Memcached cache cluster are
placed in the preferred Availability Zone. If you want to create your
cache nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
public List<String> getPreferredAvailabilityZones()
This option is
only supported on Memcached clusters. If you are creating
your cache cluster in an Amazon VPC (recommended) you can only locate
nodes in Availability Zones that are associated with the subnets in
the selected subnet group. The number of Availability Zones listed
must equal the value of NumCacheNodes
.
If you
want all your cache nodes in the same Availability Zone, use
PreferredAvailabilityZone
instead or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
This option is
only supported on Memcached clusters. If you are creating
your cache cluster in an Amazon VPC (recommended) you can only locate
nodes in Availability Zones that are associated with the subnets in
the selected subnet group. The number of Availability Zones listed
must equal the value of NumCacheNodes
.
If you
want all your cache nodes in the same Availability Zone, use
PreferredAvailabilityZone
instead or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
public void setPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)
This option is
only supported on Memcached clusters. If you are creating
your cache cluster in an Amazon VPC (recommended) you can only locate
nodes in Availability Zones that are associated with the subnets in
the selected subnet group. The number of Availability Zones listed
must equal the value of NumCacheNodes
.
If you
want all your cache nodes in the same Availability Zone, use
PreferredAvailabilityZone
instead or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
preferredAvailabilityZones
- A list of the Availability Zones in which nodes will be created. The
order of the zones in the list is not important. This option is
only supported on Memcached clusters. If you are creating
your cache cluster in an Amazon VPC (recommended) you can only locate
nodes in Availability Zones that are associated with the subnets in
the selected subnet group. The number of Availability Zones listed
must equal the value of NumCacheNodes
.
If you
want all your cache nodes in the same Availability Zone, use
PreferredAvailabilityZone
instead or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
public CreateCacheClusterRequest withPreferredAvailabilityZones(String... preferredAvailabilityZones)
This option is
only supported on Memcached clusters. If you are creating
your cache cluster in an Amazon VPC (recommended) you can only locate
nodes in Availability Zones that are associated with the subnets in
the selected subnet group. The number of Availability Zones listed
must equal the value of NumCacheNodes
.
If you
want all your cache nodes in the same Availability Zone, use
PreferredAvailabilityZone
instead or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
Returns a reference to this object so that method calls can be chained together.
preferredAvailabilityZones
- A list of the Availability Zones in which nodes will be created. The
order of the zones in the list is not important. This option is
only supported on Memcached clusters. If you are creating
your cache cluster in an Amazon VPC (recommended) you can only locate
nodes in Availability Zones that are associated with the subnets in
the selected subnet group. The number of Availability Zones listed
must equal the value of NumCacheNodes
.
If you
want all your cache nodes in the same Availability Zone, use
PreferredAvailabilityZone
instead or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
public CreateCacheClusterRequest withPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)
This option is
only supported on Memcached clusters. If you are creating
your cache cluster in an Amazon VPC (recommended) you can only locate
nodes in Availability Zones that are associated with the subnets in
the selected subnet group. The number of Availability Zones listed
must equal the value of NumCacheNodes
.
If you
want all your cache nodes in the same Availability Zone, use
PreferredAvailabilityZone
instead or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
Returns a reference to this object so that method calls can be chained together.
preferredAvailabilityZones
- A list of the Availability Zones in which nodes will be created. The
order of the zones in the list is not important. This option is
only supported on Memcached clusters. If you are creating
your cache cluster in an Amazon VPC (recommended) you can only locate
nodes in Availability Zones that are associated with the subnets in
the selected subnet group. The number of Availability Zones listed
must equal the value of NumCacheNodes
.
If you
want all your cache nodes in the same Availability Zone, use
PreferredAvailabilityZone
instead or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
public String getPreferredMaintenanceWindow()
Example: sun:05:00-sun:09:00
Example: sun:05:00-sun:09:00
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Example: sun:05:00-sun:09:00
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur. Example: sun:05:00-sun:09:00
public CreateCacheClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Example: sun:05:00-sun:09:00
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur. Example: sun:05:00-sun:09:00
public Integer getPort()
public void setPort(Integer port)
port
- The port number on which each of the cache nodes will accept
connections.public CreateCacheClusterRequest withPort(Integer port)
Returns a reference to this object so that method calls can be chained together.
port
- The port number on which each of the cache nodes 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 CreateCacheClusterRequest 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()
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
autoMinorVersionUpgrade
- Determines whether minor engine upgrades will be applied automatically
to the cache cluster during the maintenance window. A value of
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
public CreateCacheClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- Determines whether minor engine upgrades will be applied automatically
to the cache cluster during the maintenance window. A value of
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
public Boolean getAutoMinorVersionUpgrade()
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
public Integer getSnapshotRetentionLimit()
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted. If
you do not specify this parameter, then
SnapshotRetentionLimit
will be set to 0 (i.e., automatic
backups will be disabled for this cache cluster).
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted. If
you do not specify this parameter, then
SnapshotRetentionLimit
will be set to 0 (i.e., automatic
backups will be 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. If
you do not specify this parameter, then
SnapshotRetentionLimit
will be set to 0 (i.e., automatic
backups will be disabled for this cache cluster).
snapshotRetentionLimit
- The number of days for which ElastiCache will retain automatic cache
cluster 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. If
you do not specify this parameter, then
SnapshotRetentionLimit
will be set to 0 (i.e., automatic
backups will be disabled for this cache cluster).
public CreateCacheClusterRequest withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted. If
you do not specify this parameter, then
SnapshotRetentionLimit
will be set to 0 (i.e., automatic
backups will be 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 cache
cluster 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. If
you do not specify this parameter, then
SnapshotRetentionLimit
will be set to 0 (i.e., automatic
backups will be 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.
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
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.
snapshotWindow
- The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster. Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
public CreateCacheClusterRequest withSnapshotWindow(String snapshotWindow)
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
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 cache cluster. Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.