Class CreateCacheClusterRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of a CreateCacheCluster action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
This parameter is currently disabled.Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.The node group identifier.The compute and memory capacity of the nodes in the node group.The name of the parameter group to associate with this cache cluster.A list of security group names to associate with this cache cluster.The name of the subnet group to be used for the cache cluster.The name of the cache engine to be used for this cache cluster.The version number of the cache engine to be used for this cache cluster.The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.The initial number of cache nodes that the cache cluster will have.getPort()
The port number on which each of the cache nodes will accept connections.The EC2 Availability Zone in which the cache cluster will be created.A list of the Availability Zones in which cache nodes will be created.Specifies the weekly time range during which maintenance on the cache cluster is performed.The ID of the replication group to which this cache cluster should belong.One or more VPC security groups associated with the cache cluster.A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3.The name of a snapshot from which to restore data into the new node group.The number of days for which ElastiCache will retain automatic snapshots before deleting them.The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.getTags()
A list of cost allocation tags to be added to this resource.int
hashCode()
This parameter is currently disabled.void
setAutoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) This parameter is currently disabled.void
Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.void
Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.void
setCacheClusterId
(String cacheClusterId) The node group identifier.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 cache cluster.void
setCacheSecurityGroupNames
(Collection<String> cacheSecurityGroupNames) A list of security group names to associate with this cache cluster.void
setCacheSubnetGroupName
(String cacheSubnetGroupName) The name of the subnet group to be used for the cache cluster.void
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 cache 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
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 cache nodes will be created.void
setPreferredMaintenanceWindow
(String preferredMaintenanceWindow) Specifies the weekly time range during which maintenance on the cache cluster is performed.void
setReplicationGroupId
(String replicationGroupId) The ID of 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 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.toString()
Returns a string representation of this object; useful for testing and debugging.withAutoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) This parameter is currently disabled.withAZMode
(AZMode aZMode) Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.withAZMode
(String aZMode) Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.withCacheClusterId
(String cacheClusterId) The node group identifier.withCacheNodeType
(String cacheNodeType) The compute and memory capacity of the nodes in the node group.withCacheParameterGroupName
(String cacheParameterGroupName) The name of the parameter group to associate with this cache cluster.withCacheSecurityGroupNames
(String... cacheSecurityGroupNames) A list of security group names to associate with this cache cluster.withCacheSecurityGroupNames
(Collection<String> cacheSecurityGroupNames) A list of security group names to associate with this cache cluster.withCacheSubnetGroupName
(String cacheSubnetGroupName) The name of the subnet group to be used for the cache cluster.withEngine
(String engine) The name of the cache engine to be used for this cache cluster.withEngineVersion
(String engineVersion) The version number of the cache engine to be used for this cache cluster.withNotificationTopicArn
(String notificationTopicArn) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.withNumCacheNodes
(Integer numCacheNodes) The initial number of cache nodes that the cache cluster will have.The port number on which each of the cache nodes will accept connections.withPreferredAvailabilityZone
(String preferredAvailabilityZone) The EC2 Availability Zone in which the cache cluster will be created.withPreferredAvailabilityZones
(String... preferredAvailabilityZones) A list of the Availability Zones in which cache nodes will be created.withPreferredAvailabilityZones
(Collection<String> preferredAvailabilityZones) A list of the Availability Zones in which cache nodes will be created.withPreferredMaintenanceWindow
(String preferredMaintenanceWindow) Specifies the weekly time range during which maintenance on the cache cluster is performed.withReplicationGroupId
(String replicationGroupId) The ID of the replication group to which this cache cluster should belong.withSecurityGroupIds
(String... securityGroupIds) One or more VPC security groups associated with the cache cluster.withSecurityGroupIds
(Collection<String> securityGroupIds) One or more VPC security groups associated with the cache cluster.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.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.withSnapshotName
(String snapshotName) The name of a snapshot from which to restore data into the new node group.withSnapshotRetentionLimit
(Integer snapshotRetentionLimit) The number of days for which ElastiCache will retain automatic snapshots before deleting them.withSnapshotWindow
(String snapshotWindow) The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.A list of cost allocation tags to be added to this resource.withTags
(Collection<Tag> tags) A list of cost allocation tags to be added to this resource.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateCacheClusterRequest
public CreateCacheClusterRequest()Default constructor for CreateCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
CreateCacheClusterRequest
public CreateCacheClusterRequest(String cacheClusterId, Integer numCacheNodes, String cacheNodeType, String engine, List<String> cacheSecurityGroupNames) Constructs a new CreateCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
cacheClusterId
- The node group identifier. This parameter is stored as a lowercase string.Constraints:
- A name must contain from 1 to 20 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
numCacheNodes
- The initial number of cache nodes that the cache cluster will have.For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/< /a>.
cacheNodeType
- The compute and memory capacity of the nodes in the node group.Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
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.
- General purpose:
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 security group names to associate with this cache cluster.Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
-
-
Method Details
-
setCacheClusterId
The node group identifier. This parameter is stored as a lowercase string.
Constraints:
- A name must contain from 1 to 20 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
- Parameters:
cacheClusterId
- The node group identifier. This parameter is stored as a lowercase string.Constraints:
- A name must contain from 1 to 20 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
-
getCacheClusterId
The node group identifier. This parameter is stored as a lowercase string.
Constraints:
- A name must contain from 1 to 20 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
- Returns:
- The node group identifier. This parameter is stored as a
lowercase string.
Constraints:
- A name must contain from 1 to 20 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
-
withCacheClusterId
The node group identifier. This parameter is stored as a lowercase string.
Constraints:
- A name must contain from 1 to 20 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
- Parameters:
cacheClusterId
- The node group identifier. This parameter is stored as a lowercase string.Constraints:
- A name must contain from 1 to 20 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setReplicationGroupId
The ID of 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.
If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note: This parameter is only valid if the
Engine
parameter isredis
.- Parameters:
replicationGroupId
- The ID of 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.If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note: This parameter is only valid if the
Engine
parameter isredis
.
-
getReplicationGroupId
The ID of 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.
If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note: This parameter is only valid if the
Engine
parameter isredis
.- Returns:
- The ID of 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.
If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note: This parameter is only valid if the
Engine
parameter isredis
.
-
withReplicationGroupId
The ID of 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.
If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note: This parameter is only valid if the
Engine
parameter isredis
.- Parameters:
replicationGroupId
- The ID of 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.If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note: This parameter is only valid if the
Engine
parameter isredis
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAZMode
Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- Parameters:
aZMode
- Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- See Also:
-
getAZMode
Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- Returns:
- Specifies whether the nodes in this Memcached node group are
created in a single Availability Zone or created across multiple
Availability Zones in the cluster's region.
This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode. - See Also:
-
withAZMode
Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- Parameters:
aZMode
- Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAZMode
Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- Parameters:
aZMode
- Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- See Also:
-
withAZMode
Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- Parameters:
aZMode
- Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.This parameter is only supported for Memcached cache clusters.
If the
AZMode
andPreferredAvailabilityZones
are not specified, ElastiCache assumessingle-az
mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setPreferredAvailabilityZone
The EC2 Availability Zone in which the cache cluster will be created.
All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.Default: System chosen Availability Zone.
- Parameters:
preferredAvailabilityZone
- The EC2 Availability Zone in which the cache cluster will be created.All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.Default: System chosen Availability Zone.
-
getPreferredAvailabilityZone
The EC2 Availability Zone in which the cache cluster will be created.
All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.Default: System chosen Availability Zone.
- Returns:
- The EC2 Availability Zone in which the cache cluster will be
created.
All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.Default: System chosen Availability Zone.
-
withPreferredAvailabilityZone
The EC2 Availability Zone in which the cache cluster will be created.
All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.Default: System chosen Availability Zone.
- Parameters:
preferredAvailabilityZone
- The EC2 Availability Zone in which the cache cluster will be created.All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.Default: System chosen Availability Zone.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getPreferredAvailabilityZones
A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.
This option is only supported on Memcached.
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 the 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 different Availability Zones:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c]]>
Example: All three Memcached nodes in one Availability Zone:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a]]>
- Returns:
- A list of the Availability Zones in which cache nodes will be
created. The order of the zones in the list is not important.
This option is only supported on Memcached.
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 the 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 different Availability Zones:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c]]>
Example: All three Memcached nodes in one Availability Zone:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a]]>
-
setPreferredAvailabilityZones
A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.
This option is only supported on Memcached.
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 the 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 different Availability Zones:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c]]>
Example: All three Memcached nodes in one Availability Zone:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a]]>
- Parameters:
preferredAvailabilityZones
- A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.This option is only supported on Memcached.
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 the 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 different Availability Zones:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c]]>
Example: All three Memcached nodes in one Availability Zone:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a]]>
-
withPreferredAvailabilityZones
public CreateCacheClusterRequest withPreferredAvailabilityZones(String... preferredAvailabilityZones) A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.
This option is only supported on Memcached.
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 the 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 different Availability Zones:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c]]>
Example: All three Memcached nodes in one Availability Zone:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a]]>
NOTE: This method appends the values to the existing list (if any). Use
setPreferredAvailabilityZones(java.util.Collection)
orwithPreferredAvailabilityZones(java.util.Collection)
if you want to override the existing values.- Parameters:
preferredAvailabilityZones
- A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.This option is only supported on Memcached.
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 the 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 different Availability Zones:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c]]>
Example: All three Memcached nodes in one Availability Zone:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a]]>
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withPreferredAvailabilityZones
public CreateCacheClusterRequest withPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones) A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.
This option is only supported on Memcached.
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 the 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 different Availability Zones:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c]]>
Example: All three Memcached nodes in one Availability Zone:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a]]>
- Parameters:
preferredAvailabilityZones
- A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.This option is only supported on Memcached.
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 the 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 different Availability Zones:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c]]>
Example: All three Memcached nodes in one Availability Zone:
<![CDATA[PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a]]>
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNumCacheNodes
The initial number of cache nodes that the cache cluster will have.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
- Parameters:
numCacheNodes
- The initial number of cache nodes that the cache cluster will have.For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/< /a>.
-
getNumCacheNodes
The initial number of cache nodes that the cache cluster will have.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
- Returns:
- The initial number of cache nodes that the cache cluster will
have.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/ .
-
withNumCacheNodes
The initial number of cache nodes that the cache cluster will have.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
- Parameters:
numCacheNodes
- The initial number of cache nodes that the cache cluster will have.For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/< /a>.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheNodeType
The compute and memory capacity of the nodes in the node group.
Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
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.
- Parameters:
cacheNodeType
- The compute and memory capacity of the nodes in the node group.Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
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.
- General purpose:
- General purpose:
-
getCacheNodeType
The compute and memory capacity of the nodes in the node group.
Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
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:
- The compute and memory capacity of the nodes in the node
group.
Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
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.
- General purpose:
- General purpose:
-
withCacheNodeType
The compute and memory capacity of the nodes in the node group.
Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
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.
- Parameters:
cacheNodeType
- The compute and memory capacity of the nodes in the node group.Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
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.
- General purpose:
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- General purpose:
-
setEngine
The name of the cache engine to be used for this cache cluster.
Valid values for this parameter are:
memcached
|redis
- Parameters:
engine
- The name of the cache engine to be used for this cache cluster.Valid values for this parameter are:
memcached
|redis
-
getEngine
The name of the cache engine to be used for this cache cluster.
Valid values for this parameter are:
memcached
|redis
- Returns:
- The name of the cache engine to be used for this cache
cluster.
Valid values for this parameter are:
memcached
|redis
-
withEngine
The name of the cache engine to be used for this cache cluster.
Valid values for this parameter are:
memcached
|redis
- Parameters:
engine
- The name of the cache engine to be used for this cache cluster.Valid values for this parameter are:
memcached
|redis
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEngineVersion
The version number of the cache engine to be used for this cache cluster. 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.
- Parameters:
engineVersion
- The version number of the cache engine to be used for this cache cluster. 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.
-
getEngineVersion
The version number of the cache engine to be used for this cache cluster. 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.
- Returns:
- The version number of the cache engine to be used for this cache
cluster. 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.
-
withEngineVersion
The version number of the cache engine to be used for this cache cluster. 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.
- Parameters:
engineVersion
- The version number of the cache engine to be used for this cache cluster. 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheParameterGroupName
The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.
- Parameters:
cacheParameterGroupName
- The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.
-
getCacheParameterGroupName
The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.
- Returns:
- The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.
-
withCacheParameterGroupName
The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.
- Parameters:
cacheParameterGroupName
- The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheSubnetGroupName
The name of the subnet group to be used for the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
- Parameters:
cacheSubnetGroupName
- The name of the subnet group to be used for the cache cluster.Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
-
getCacheSubnetGroupName
The name of the subnet group to be used for the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
- Returns:
- The name of the subnet group to be used for the cache
cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
-
withCacheSubnetGroupName
The name of the subnet group to be used for the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
- Parameters:
cacheSubnetGroupName
- The name of the subnet group to be used for the cache cluster.Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCacheSecurityGroupNames
A list of security group names to associate with this cache cluster.
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
- Returns:
- A list of security group names to associate with this cache
cluster.
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
-
setCacheSecurityGroupNames
A list of security group names to associate with this cache cluster.
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
- Parameters:
cacheSecurityGroupNames
- A list of security group names to associate with this cache cluster.Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
-
withCacheSecurityGroupNames
A list of security group names to associate with this cache cluster.
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
NOTE: This method appends the values to the existing list (if any). Use
setCacheSecurityGroupNames(java.util.Collection)
orwithCacheSecurityGroupNames(java.util.Collection)
if you want to override the existing values.- Parameters:
cacheSecurityGroupNames
- A list of security group names to associate with this cache cluster.Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCacheSecurityGroupNames
public CreateCacheClusterRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames) A list of security group names to associate with this cache cluster.
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
- Parameters:
cacheSecurityGroupNames
- A list of security group names to associate with this cache cluster.Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getSecurityGroupIds
One or more VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
- Returns:
- One or more VPC security groups associated with the cache
cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
-
setSecurityGroupIds
One or more VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
- Parameters:
securityGroupIds
- One or more VPC security groups associated with the cache cluster.Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
-
withSecurityGroupIds
One or more VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroupIds(java.util.Collection)
orwithSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
securityGroupIds
- One or more VPC security groups associated with the cache cluster.Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withSecurityGroupIds
One or more VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
- Parameters:
securityGroupIds
- One or more VPC security groups associated with the cache cluster.Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
- Returns:
- 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.
-
setTags
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.
- Parameters:
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.
-
withTags
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getSnapshotArns
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 isredis
.Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
- Returns:
- 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 isredis
.Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
-
setSnapshotArns
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 isredis
.Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
- Parameters:
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 isredis
.Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
-
withSnapshotArns
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 isredis
.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)
orwithSnapshotArns(java.util.Collection)
if you want to override the existing values.- Parameters:
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 isredis
.Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withSnapshotArns
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 isredis
.Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
- Parameters:
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 isredis
.Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotName
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 isredis
.- Parameters:
snapshotName
- The name of a snapshot from which to restore data into the new node group. The snapshot status changes torestoring
while the new node group is being created.Note: This parameter is only valid if the
Engine
parameter isredis
.
-
getSnapshotName
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 isredis
.- Returns:
- 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 isredis
.
-
withSnapshotName
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 isredis
.- Parameters:
snapshotName
- The name of a snapshot from which to restore data into the new node group. The snapshot status changes torestoring
while the new node group is being created.Note: This parameter is only valid if the
Engine
parameter isredis
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredMaintenanceWindow
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
- Parameters:
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 forddd
are:sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
-
getPreferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for
ddd
are:sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
- Returns:
- 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
-
withPreferredMaintenanceWindow
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
- Parameters:
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 forddd
are:sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPort
The port number on which each of the cache nodes will accept connections.
- Parameters:
port
- The port number on which each of the cache nodes will accept connections.
-
getPort
The port number on which each of the cache nodes will accept connections.
- Returns:
- The port number on which each of the cache nodes will accept connections.
-
withPort
The port number on which each of the cache nodes will accept connections.
- Parameters:
port
- The port number on which each of the cache nodes will accept connections.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNotificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
The Amazon SNS topic owner must be the same as the cache cluster owner. - Parameters:
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.The Amazon SNS topic owner must be the same as the cache cluster owner.
-
getNotificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
The Amazon SNS topic owner must be the same as the cache cluster owner. - Returns:
- The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent.
The Amazon SNS topic owner must be the same as the cache cluster owner.
-
withNotificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
The Amazon SNS topic owner must be the same as the cache cluster owner. - Parameters:
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.The Amazon SNS topic owner must be the same as the cache cluster owner. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAutoMinorVersionUpgrade
This parameter is currently disabled.
- Parameters:
autoMinorVersionUpgrade
- This parameter is currently disabled.
-
getAutoMinorVersionUpgrade
This parameter is currently disabled.
- Returns:
- This parameter is currently disabled.
-
withAutoMinorVersionUpgrade
This parameter is currently disabled.
- Parameters:
autoMinorVersionUpgrade
- This parameter is currently disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAutoMinorVersionUpgrade
This parameter is currently disabled.
- Returns:
- This parameter is currently disabled.
-
setSnapshotRetentionLimit
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 isredis
.Default: 0 (i.e., automatic backups are disabled for this cache cluster).
- Parameters:
snapshotRetentionLimit
- The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you setSnapshotRetentionLimit
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 isredis
.Default: 0 (i.e., automatic backups are disabled for this cache cluster).
-
getSnapshotRetentionLimit
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 isredis
.Default: 0 (i.e., automatic backups are disabled for this cache cluster).
- Returns:
- 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 isredis
.Default: 0 (i.e., automatic backups are disabled for this cache cluster).
-
withSnapshotRetentionLimit
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 isredis
.Default: 0 (i.e., automatic backups are disabled for this cache cluster).
- Parameters:
snapshotRetentionLimit
- The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you setSnapshotRetentionLimit
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 isredis
.Default: 0 (i.e., automatic backups are disabled for this cache cluster).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotWindow
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 isredis
.- Parameters:
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 isredis
.
-
getSnapshotWindow
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 isredis
.- Returns:
- 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 isredis
.
-
withSnapshotWindow
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 isredis
.- Parameters:
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 isredis
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-