com.amazonaws.services.elasticache.model.CreateCacheClusterRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.elasticache.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input of a CreateCacheCluster action.
*
*/
public class CreateCacheClusterRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* 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.
*
*
*
*/
private String cacheClusterId;
/**
*
* 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*/
private String replicationGroupId;
/**
*
* 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 and PreferredAvailabilityZones
* are not specified, ElastiCache assumes single-az mode.
*
*/
private String aZMode;
/**
*
* 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.
*
*/
private String preferredAvailabilityZone;
/**
*
* 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:
* 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:
* PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
*
*/
private com.amazonaws.internal.SdkInternalList preferredAvailabilityZones;
/**
*
* 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/.
*
*/
private Integer numCacheNodes;
/**
*
* 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
*
*
*
*
* -
*
* Compute optimized: cache.c1.xlarge
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation: cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
* -
*
* Previous generation: cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
*
*
*
*
*
* Notes:
*
*
* -
*
* All t2 instances are created in an Amazon Virtual Private Cloud (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.
*
*/
private String cacheNodeType;
/**
*
* The name of the cache engine to be used for this cache cluster.
*
*
* Valid values for this parameter are:
*
*
* memcached | redis
*
*/
private String engine;
/**
*
* 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.
*
*/
private String engineVersion;
/**
*
* 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.
*
*/
private String cacheParameterGroupName;
/**
*
* 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).
*
*/
private String cacheSubnetGroupName;
/**
*
* 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).
*
*/
private com.amazonaws.internal.SdkInternalList cacheSecurityGroupNames;
/**
*
* 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).
*
*/
private com.amazonaws.internal.SdkInternalList securityGroupIds;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* Example of an Amazon S3 ARN:
* arn:aws:s3:::my_bucket/snapshot1.rdb
*
*/
private com.amazonaws.internal.SdkInternalList snapshotArns;
/**
*
* 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*/
private String snapshotName;
/**
*
* 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
*
*/
private String preferredMaintenanceWindow;
/**
*
* The port number on which each of the cache nodes will accept connections.
*
*/
private Integer port;
/**
*
* 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.
*
*
*/
private String notificationTopicArn;
/**
*
* This parameter is currently disabled.
*
*/
private Boolean autoMinorVersionUpgrade;
/**
*
* 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* Default: 0 (i.e., automatic backups are disabled for this cache cluster).
*
*/
private Integer snapshotRetentionLimit;
/**
*
* The daily time range (in UTC) during which ElastiCache will begin taking
* a daily snapshot of your node group.
*
*
* Example: 05:00-09:00
*
*
* If you do not specify this parameter, then ElastiCache will automatically
* choose an appropriate time range.
*
*
* Note: This parameter is only valid if the Engine
* parameter is redis.
*
*/
private String snapshotWindow;
/**
* Default constructor for CreateCacheClusterRequest object. Callers should
* use the setter or fluent setter (with...) methods to initialize the
* object after creating it.
*/
public CreateCacheClusterRequest() {
}
/**
* Constructs a new CreateCacheClusterRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize any additional
* object members.
*
* @param 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.
*
*
* @param 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>.
* @param 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
*
*
*
*
* -
*
* Compute optimized: cache.c1.xlarge
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation: cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
* -
*
* Previous generation: cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
*
*
*
*
*
* Notes:
*
*
* -
*
* All t2 instances are created in an Amazon Virtual Private Cloud
* (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.
* @param engine
* The name of the cache engine to be used for this cache cluster.
*
*
* Valid values for this parameter are:
*
*
* memcached | redis
* @param 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).
*/
public CreateCacheClusterRequest(String cacheClusterId,
Integer numCacheNodes, String cacheNodeType, String engine,
java.util.List cacheSecurityGroupNames) {
setCacheClusterId(cacheClusterId);
setNumCacheNodes(numCacheNodes);
setCacheNodeType(cacheNodeType);
setEngine(engine);
setCacheSecurityGroupNames(cacheSecurityGroupNames);
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
*/
public void setCacheClusterId(String cacheClusterId) {
this.cacheClusterId = 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.
*
*
*
*
* @return 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.
*
*
*/
public String getCacheClusterId() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withCacheClusterId(String cacheClusterId) {
setCacheClusterId(cacheClusterId);
return this;
}
/**
*
* 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* @param 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.
*
*
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*/
public void setReplicationGroupId(String replicationGroupId) {
this.replicationGroupId = 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* @return 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.
*
*
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*/
public String getReplicationGroupId() {
return this.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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* @param 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.
*
*
*
* This parameter is only valid if the Engine parameter
* is redis.
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withReplicationGroupId(
String replicationGroupId) {
setReplicationGroupId(replicationGroupId);
return this;
}
/**
*
* 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 and PreferredAvailabilityZones
* are not specified, ElastiCache assumes single-az mode.
*
*
* @param 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 and
* PreferredAvailabilityZones are not specified,
* ElastiCache assumes single-az mode.
* @see AZMode
*/
public void setAZMode(String aZMode) {
this.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.
*
*
* This parameter is only supported for Memcached cache clusters.
*
*
* If the AZMode and PreferredAvailabilityZones
* are not specified, ElastiCache assumes single-az mode.
*
*
* @return 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 and
* PreferredAvailabilityZones are not specified,
* ElastiCache assumes single-az mode.
* @see AZMode
*/
public String getAZMode() {
return this.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 and PreferredAvailabilityZones
* are not specified, ElastiCache assumes single-az mode.
*
*
* @param 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 and
* PreferredAvailabilityZones are not specified,
* ElastiCache assumes single-az mode.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see AZMode
*/
public CreateCacheClusterRequest withAZMode(String aZMode) {
setAZMode(aZMode);
return this;
}
/**
*
* 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 and PreferredAvailabilityZones
* are not specified, ElastiCache assumes single-az mode.
*
*
* @param 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 and
* PreferredAvailabilityZones are not specified,
* ElastiCache assumes single-az mode.
* @see AZMode
*/
public void setAZMode(AZMode aZMode) {
this.aZMode = aZMode.toString();
}
/**
*
* 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 and PreferredAvailabilityZones
* are not specified, ElastiCache assumes single-az mode.
*
*
* @param 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 and
* PreferredAvailabilityZones are not specified,
* ElastiCache assumes single-az mode.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see AZMode
*/
public CreateCacheClusterRequest withAZMode(AZMode aZMode) {
setAZMode(aZMode);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPreferredAvailabilityZone(String preferredAvailabilityZone) {
this.preferredAvailabilityZone = 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.
*
*
* @return 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.
*/
public String getPreferredAvailabilityZone() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withPreferredAvailabilityZone(
String preferredAvailabilityZone) {
setPreferredAvailabilityZone(preferredAvailabilityZone);
return this;
}
/**
*
* 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:
* 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:
* PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
*
*
* @return 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:
* 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:
* PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
*/
public java.util.List getPreferredAvailabilityZones() {
if (preferredAvailabilityZones == null) {
preferredAvailabilityZones = new com.amazonaws.internal.SdkInternalList();
}
return 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:
* 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:
* PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
*
*
* @param 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:
* 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:
* PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
*/
public void setPreferredAvailabilityZones(
java.util.Collection preferredAvailabilityZones) {
if (preferredAvailabilityZones == null) {
this.preferredAvailabilityZones = null;
return;
}
this.preferredAvailabilityZones = new com.amazonaws.internal.SdkInternalList(
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:
* 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:
* 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 {@link #setPreferredAvailabilityZones(java.util.Collection)} or
* {@link #withPreferredAvailabilityZones(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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:
* 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:
* PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withPreferredAvailabilityZones(
String... preferredAvailabilityZones) {
if (this.preferredAvailabilityZones == null) {
setPreferredAvailabilityZones(new com.amazonaws.internal.SdkInternalList(
preferredAvailabilityZones.length));
}
for (String ele : preferredAvailabilityZones) {
this.preferredAvailabilityZones.add(ele);
}
return this;
}
/**
*
* 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:
* 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:
* PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
*
*
* @param 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:
* 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:
* PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withPreferredAvailabilityZones(
java.util.Collection preferredAvailabilityZones) {
setPreferredAvailabilityZones(preferredAvailabilityZones);
return this;
}
/**
*
* 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/.
*
*
* @param 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>.
*/
public void setNumCacheNodes(Integer numCacheNodes) {
this.numCacheNodes = 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/.
*
*
* @return 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/
* .
*/
public Integer getNumCacheNodes() {
return this.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/.
*
*
* @param 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>.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withNumCacheNodes(Integer numCacheNodes) {
setNumCacheNodes(numCacheNodes);
return this;
}
/**
*
* 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
*
*
*
*
* -
*
* Compute optimized: cache.c1.xlarge
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation: cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
* -
*
* Previous generation: cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
*
*
*
*
*
* Notes:
*
*
* -
*
* All t2 instances are created in an Amazon Virtual Private Cloud (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.
*
*
* @param 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
*
*
*
*
* -
*
* Compute optimized: cache.c1.xlarge
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation: cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
* -
*
* Previous generation: cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
*
*
*
*
*
* Notes:
*
*
* -
*
* All t2 instances are created in an Amazon Virtual Private Cloud
* (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.
*/
public void setCacheNodeType(String cacheNodeType) {
this.cacheNodeType = 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
*
*
*
*
* -
*
* Compute optimized: cache.c1.xlarge
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation: cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
* -
*
* Previous generation: cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
*
*
*
*
*
* Notes:
*
*
* -
*
* All t2 instances are created in an Amazon Virtual Private Cloud (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.
*
*
* @return 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
*
*
*
*
* -
*
* Compute optimized: cache.c1.xlarge
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation: cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
* -
*
* Previous generation: cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
*
*
*
*
*
* Notes:
*
*
* -
*
* All t2 instances are created in an Amazon Virtual Private Cloud
* (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.
*/
public String getCacheNodeType() {
return this.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
*
*
*
*
* -
*
* Compute optimized: cache.c1.xlarge
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation: cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
* -
*
* Previous generation: cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
*
*
*
*
*
* Notes:
*
*
* -
*
* All t2 instances are created in an Amazon Virtual Private Cloud (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.
*
*
* @param 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
*
*
*
*
* -
*
* Compute optimized: cache.c1.xlarge
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation: cache.r3.large,
* cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
* -
*
* Previous generation: cache.m2.xlarge,
* cache.m2.2xlarge, cache.m2.4xlarge
*
*
*
*
*
*
* Notes:
*
*
* -
*
* All t2 instances are created in an Amazon Virtual Private Cloud
* (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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withCacheNodeType(String cacheNodeType) {
setCacheNodeType(cacheNodeType);
return this;
}
/**
*
* The name of the cache engine to be used for this cache cluster.
*
*
* Valid values for this parameter are:
*
*
* memcached | redis
*
*
* @param engine
* The name of the cache engine to be used for this cache
* cluster.
*
* Valid values for this parameter are:
*
*
* memcached | redis
*/
public void setEngine(String engine) {
this.engine = engine;
}
/**
*
* The name of the cache engine to be used for this cache cluster.
*
*
* Valid values for this parameter are:
*
*
* memcached | redis
*
*
* @return The name of the cache engine to be used for this cache
* cluster.
*
* Valid values for this parameter are:
*
*
* memcached | redis
*/
public String getEngine() {
return this.engine;
}
/**
*
* The name of the cache engine to be used for this cache cluster.
*
*
* Valid values for this parameter are:
*
*
* memcached | redis
*
*
* @param engine
* The name of the cache engine to be used for this cache
* cluster.
*
* Valid values for this parameter are:
*
*
* memcached | redis
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withEngine(String engine) {
setEngine(engine);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setEngineVersion(String engineVersion) {
this.engineVersion = 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.
*
*
* @return 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.
*/
public String getEngineVersion() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withEngineVersion(String engineVersion) {
setEngineVersion(engineVersion);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setCacheParameterGroupName(String cacheParameterGroupName) {
this.cacheParameterGroupName = 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.
*
*
* @return 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.
*/
public String getCacheParameterGroupName() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withCacheParameterGroupName(
String cacheParameterGroupName) {
setCacheParameterGroupName(cacheParameterGroupName);
return this;
}
/**
*
* 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).
*
*
* @param 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).
*/
public void setCacheSubnetGroupName(String cacheSubnetGroupName) {
this.cacheSubnetGroupName = 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).
*
*
* @return 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).
*/
public String getCacheSubnetGroupName() {
return this.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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withCacheSubnetGroupName(
String cacheSubnetGroupName) {
setCacheSubnetGroupName(cacheSubnetGroupName);
return this;
}
/**
*
* 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).
*
*
* @return 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).
*/
public java.util.List getCacheSecurityGroupNames() {
if (cacheSecurityGroupNames == null) {
cacheSecurityGroupNames = new com.amazonaws.internal.SdkInternalList();
}
return 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).
*
*
* @param 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).
*/
public void setCacheSecurityGroupNames(
java.util.Collection cacheSecurityGroupNames) {
if (cacheSecurityGroupNames == null) {
this.cacheSecurityGroupNames = null;
return;
}
this.cacheSecurityGroupNames = new com.amazonaws.internal.SdkInternalList(
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).
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setCacheSecurityGroupNames(java.util.Collection)} or
* {@link #withCacheSecurityGroupNames(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withCacheSecurityGroupNames(
String... cacheSecurityGroupNames) {
if (this.cacheSecurityGroupNames == null) {
setCacheSecurityGroupNames(new com.amazonaws.internal.SdkInternalList(
cacheSecurityGroupNames.length));
}
for (String ele : cacheSecurityGroupNames) {
this.cacheSecurityGroupNames.add(ele);
}
return this;
}
/**
*
* 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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withCacheSecurityGroupNames(
java.util.Collection cacheSecurityGroupNames) {
setCacheSecurityGroupNames(cacheSecurityGroupNames);
return this;
}
/**
*
* 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).
*
*
* @return 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).
*/
public java.util.List getSecurityGroupIds() {
if (securityGroupIds == null) {
securityGroupIds = new com.amazonaws.internal.SdkInternalList();
}
return 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).
*
*
* @param 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).
*/
public void setSecurityGroupIds(
java.util.Collection securityGroupIds) {
if (securityGroupIds == null) {
this.securityGroupIds = null;
return;
}
this.securityGroupIds = new com.amazonaws.internal.SdkInternalList(
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).
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setSecurityGroupIds(java.util.Collection)} or
* {@link #withSecurityGroupIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withSecurityGroupIds(
String... securityGroupIds) {
if (this.securityGroupIds == null) {
setSecurityGroupIds(new com.amazonaws.internal.SdkInternalList(
securityGroupIds.length));
}
for (String ele : securityGroupIds) {
this.securityGroupIds.add(ele);
}
return this;
}
/**
*
* 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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withSecurityGroupIds(
java.util.Collection securityGroupIds) {
setSecurityGroupIds(securityGroupIds);
return this;
}
/**
*
* 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.
*
*
* @return A list of cost allocation tags to be added to this resource. A
* tag is a key-value pair. A tag key must be accompanied by a tag
* value.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param tags
* A list of cost allocation tags to be added to this resource. A tag
* is a key-value pair. A tag key must be accompanied by a tag value.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* A list of cost allocation tags to be added to this resource. A tag is a
* key-value pair. A tag key must be accompanied by a tag value.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setTags(java.util.Collection)} or
* {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* Example of an Amazon S3 ARN:
* arn:aws:s3:::my_bucket/snapshot1.rdb
*
*
* @return 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.
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*
*
* Example of an Amazon S3 ARN:
* arn:aws:s3:::my_bucket/snapshot1.rdb
*/
public java.util.List getSnapshotArns() {
if (snapshotArns == null) {
snapshotArns = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* Example of an Amazon S3 ARN:
* arn:aws:s3:::my_bucket/snapshot1.rdb
*
*
* @param 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.
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*
*
* Example of an Amazon S3 ARN:
* arn:aws:s3:::my_bucket/snapshot1.rdb
*/
public void setSnapshotArns(java.util.Collection snapshotArns) {
if (snapshotArns == null) {
this.snapshotArns = null;
return;
}
this.snapshotArns = new com.amazonaws.internal.SdkInternalList(
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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* Example of an Amazon S3 ARN:
* arn:aws:s3:::my_bucket/snapshot1.rdb
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setSnapshotArns(java.util.Collection)} or
* {@link #withSnapshotArns(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param 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.
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*
*
* Example of an Amazon S3 ARN:
* arn:aws:s3:::my_bucket/snapshot1.rdb
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withSnapshotArns(String... snapshotArns) {
if (this.snapshotArns == null) {
setSnapshotArns(new com.amazonaws.internal.SdkInternalList(
snapshotArns.length));
}
for (String ele : snapshotArns) {
this.snapshotArns.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* Example of an Amazon S3 ARN:
* arn:aws:s3:::my_bucket/snapshot1.rdb
*
*
* @param 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.
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*
*
* Example of an Amazon S3 ARN:
* arn:aws:s3:::my_bucket/snapshot1.rdb
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withSnapshotArns(
java.util.Collection snapshotArns) {
setSnapshotArns(snapshotArns);
return this;
}
/**
*
* 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* @param snapshotName
* The name of a snapshot from which to restore data into the new
* node group. The snapshot status changes to restoring
* while the new node group is being created.
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*/
public void setSnapshotName(String snapshotName) {
this.snapshotName = snapshotName;
}
/**
*
* The name of a snapshot from which to restore data into the new node
* group. The snapshot status changes to restoring while the
* new node group is being created.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* @return 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.
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*/
public String getSnapshotName() {
return this.snapshotName;
}
/**
*
* The name of a snapshot from which to restore data into the new node
* group. The snapshot status changes to restoring while the
* new node group is being created.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* @param snapshotName
* The name of a snapshot from which to restore data into the new
* node group. The snapshot status changes to restoring
* while the new node group is being created.
*
* This parameter is only valid if the Engine parameter
* is redis.
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withSnapshotName(String snapshotName) {
setSnapshotName(snapshotName);
return this;
}
/**
*
* 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
*
*
* @param preferredMaintenanceWindow
* Specifies the weekly time range during which maintenance on the
* cache cluster is performed. It is specified as a range in the
* format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum
* maintenance window is a 60 minute period. Valid values for
* ddd are:
*
* -
*
* sun
*
*
* -
*
* mon
*
*
* -
*
* tue
*
*
* -
*
* wed
*
*
* -
*
* thu
*
*
* -
*
* fri
*
*
* -
*
* sat
*
*
*
*
* Example: sun:05:00-sun:09:00
*/
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow) {
this.preferredMaintenanceWindow = preferredMaintenanceWindow;
}
/**
*
* Specifies the weekly time range during which maintenance on the cache
* cluster is performed. It is specified as a range in the format
* ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
* is a 60 minute period. Valid values for ddd are:
*
*
* -
*
* sun
*
*
* -
*
* mon
*
*
* -
*
* tue
*
*
* -
*
* wed
*
*
* -
*
* thu
*
*
* -
*
* fri
*
*
* -
*
* sat
*
*
*
*
* Example: sun:05:00-sun:09:00
*
*
* @return Specifies the weekly time range during which maintenance on the
* cache cluster is performed. It is specified as a range in the
* format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum
* maintenance window is a 60 minute period. Valid values for
* ddd are:
*
* -
*
* sun
*
*
* -
*
* mon
*
*
* -
*
* tue
*
*
* -
*
* wed
*
*
* -
*
* thu
*
*
* -
*
* fri
*
*
* -
*
* sat
*
*
*
*
* Example: sun:05:00-sun:09:00
*/
public String getPreferredMaintenanceWindow() {
return this.preferredMaintenanceWindow;
}
/**
*
* Specifies the weekly time range during which maintenance on the cache
* cluster is performed. It is specified as a range in the format
* ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
* is a 60 minute period. Valid values for ddd are:
*
*
* -
*
* sun
*
*
* -
*
* mon
*
*
* -
*
* tue
*
*
* -
*
* wed
*
*
* -
*
* thu
*
*
* -
*
* fri
*
*
* -
*
* sat
*
*
*
*
* Example: sun:05:00-sun:09:00
*
*
* @param preferredMaintenanceWindow
* Specifies the weekly time range during which maintenance on the
* cache cluster is performed. It is specified as a range in the
* format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum
* maintenance window is a 60 minute period. Valid values for
* ddd are:
*
* -
*
* sun
*
*
* -
*
* mon
*
*
* -
*
* tue
*
*
* -
*
* wed
*
*
* -
*
* thu
*
*
* -
*
* fri
*
*
* -
*
* sat
*
*
*
*
* Example: sun:05:00-sun:09:00
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withPreferredMaintenanceWindow(
String preferredMaintenanceWindow) {
setPreferredMaintenanceWindow(preferredMaintenanceWindow);
return this;
}
/**
*
* The port number on which each of the cache nodes will accept connections.
*
*
* @param port
* The port number on which each of the cache nodes will accept
* connections.
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The port number on which each of the cache nodes will accept connections.
*
*
* @return The port number on which each of the cache nodes will accept
* connections.
*/
public Integer getPort() {
return this.port;
}
/**
*
* The port number on which each of the cache nodes will accept connections.
*
*
* @param port
* The port number on which each of the cache nodes will accept
* connections.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withPort(Integer port) {
setPort(port);
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setNotificationTopicArn(String notificationTopicArn) {
this.notificationTopicArn = 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.
*
*
*
* @return 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.
*
*/
public String getNotificationTopicArn() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withNotificationTopicArn(
String notificationTopicArn) {
setNotificationTopicArn(notificationTopicArn);
return this;
}
/**
*
* This parameter is currently disabled.
*
*
* @param autoMinorVersionUpgrade
* This parameter is currently disabled.
*/
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) {
this.autoMinorVersionUpgrade = autoMinorVersionUpgrade;
}
/**
*
* This parameter is currently disabled.
*
*
* @return This parameter is currently disabled.
*/
public Boolean getAutoMinorVersionUpgrade() {
return this.autoMinorVersionUpgrade;
}
/**
*
* This parameter is currently disabled.
*
*
* @param autoMinorVersionUpgrade
* This parameter is currently disabled.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withAutoMinorVersionUpgrade(
Boolean autoMinorVersionUpgrade) {
setAutoMinorVersionUpgrade(autoMinorVersionUpgrade);
return this;
}
/**
*
* This parameter is currently disabled.
*
*
* @return This parameter is currently disabled.
*/
public Boolean isAutoMinorVersionUpgrade() {
return this.autoMinorVersionUpgrade;
}
/**
*
* 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.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* Default: 0 (i.e., automatic backups are disabled for this cache cluster).
*
*
* @param snapshotRetentionLimit
* The number of days for which ElastiCache will retain automatic
* snapshots before deleting them. For example, if you set
* SnapshotRetentionLimit to 5, then a snapshot that was
* taken today will be retained for 5 days before being deleted.
*
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*
*
* Default: 0 (i.e., automatic backups are disabled for this cache
* cluster).
*/
public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit) {
this.snapshotRetentionLimit = snapshotRetentionLimit;
}
/**
*
* The number of days for which ElastiCache will retain automatic snapshots
* before deleting them. For example, if you set
* SnapshotRetentionLimit to 5, then a snapshot that was taken
* today will be retained for 5 days before being deleted.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* Default: 0 (i.e., automatic backups are disabled for this cache cluster).
*
*
* @return 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.
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*
*
* Default: 0 (i.e., automatic backups are disabled for this cache
* cluster).
*/
public Integer getSnapshotRetentionLimit() {
return this.snapshotRetentionLimit;
}
/**
*
* The number of days for which ElastiCache will retain automatic snapshots
* before deleting them. For example, if you set
* SnapshotRetentionLimit to 5, then a snapshot that was taken
* today will be retained for 5 days before being deleted.
*
*
*
* This parameter is only valid if the Engine parameter is
* redis.
*
*
*
* Default: 0 (i.e., automatic backups are disabled for this cache cluster).
*
*
* @param snapshotRetentionLimit
* The number of days for which ElastiCache will retain automatic
* snapshots before deleting them. For example, if you set
* SnapshotRetentionLimit to 5, then a snapshot that was
* taken today will be retained for 5 days before being deleted.
*
*
* This parameter is only valid if the Engine parameter
* is redis.
*
*
*
* Default: 0 (i.e., automatic backups are disabled for this cache
* cluster).
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withSnapshotRetentionLimit(
Integer snapshotRetentionLimit) {
setSnapshotRetentionLimit(snapshotRetentionLimit);
return this;
}
/**
*
* The daily time range (in UTC) during which ElastiCache will begin taking
* a daily snapshot of your node group.
*
*
* Example: 05:00-09:00
*
*
* If you do not specify this parameter, then ElastiCache will automatically
* choose an appropriate time range.
*
*
* Note: This parameter is only valid if the Engine
* parameter is redis.
*
*
* @param snapshotWindow
* The daily time range (in UTC) during which ElastiCache will begin
* taking a daily snapshot of your node group.
*
* Example: 05:00-09:00
*
*
* If you do not specify this parameter, then ElastiCache will
* automatically choose an appropriate time range.
*
*
* Note: This parameter is only valid if the
* Engine parameter is redis.
*/
public void setSnapshotWindow(String snapshotWindow) {
this.snapshotWindow = snapshotWindow;
}
/**
*
* The daily time range (in UTC) during which ElastiCache will begin taking
* a daily snapshot of your node group.
*
*
* Example: 05:00-09:00
*
*
* If you do not specify this parameter, then ElastiCache will automatically
* choose an appropriate time range.
*
*
* Note: This parameter is only valid if the Engine
* parameter is redis.
*
*
* @return The daily time range (in UTC) during which ElastiCache will begin
* taking a daily snapshot of your node group.
*
* Example: 05:00-09:00
*
*
* If you do not specify this parameter, then ElastiCache will
* automatically choose an appropriate time range.
*
*
* Note: This parameter is only valid if the
* Engine parameter is redis.
*/
public String getSnapshotWindow() {
return this.snapshotWindow;
}
/**
*
* The daily time range (in UTC) during which ElastiCache will begin taking
* a daily snapshot of your node group.
*
*
* Example: 05:00-09:00
*
*
* If you do not specify this parameter, then ElastiCache will automatically
* choose an appropriate time range.
*
*
* Note: This parameter is only valid if the Engine
* parameter is redis.
*
*
* @param snapshotWindow
* The daily time range (in UTC) during which ElastiCache will begin
* taking a daily snapshot of your node group.
*
* Example: 05:00-09:00
*
*
* If you do not specify this parameter, then ElastiCache will
* automatically choose an appropriate time range.
*
*
* Note: This parameter is only valid if the
* Engine parameter is redis.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateCacheClusterRequest withSnapshotWindow(String snapshotWindow) {
setSnapshotWindow(snapshotWindow);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCacheClusterId() != null)
sb.append("CacheClusterId: " + getCacheClusterId() + ",");
if (getReplicationGroupId() != null)
sb.append("ReplicationGroupId: " + getReplicationGroupId() + ",");
if (getAZMode() != null)
sb.append("AZMode: " + getAZMode() + ",");
if (getPreferredAvailabilityZone() != null)
sb.append("PreferredAvailabilityZone: "
+ getPreferredAvailabilityZone() + ",");
if (getPreferredAvailabilityZones() != null)
sb.append("PreferredAvailabilityZones: "
+ getPreferredAvailabilityZones() + ",");
if (getNumCacheNodes() != null)
sb.append("NumCacheNodes: " + getNumCacheNodes() + ",");
if (getCacheNodeType() != null)
sb.append("CacheNodeType: " + getCacheNodeType() + ",");
if (getEngine() != null)
sb.append("Engine: " + getEngine() + ",");
if (getEngineVersion() != null)
sb.append("EngineVersion: " + getEngineVersion() + ",");
if (getCacheParameterGroupName() != null)
sb.append("CacheParameterGroupName: "
+ getCacheParameterGroupName() + ",");
if (getCacheSubnetGroupName() != null)
sb.append("CacheSubnetGroupName: " + getCacheSubnetGroupName()
+ ",");
if (getCacheSecurityGroupNames() != null)
sb.append("CacheSecurityGroupNames: "
+ getCacheSecurityGroupNames() + ",");
if (getSecurityGroupIds() != null)
sb.append("SecurityGroupIds: " + getSecurityGroupIds() + ",");
if (getTags() != null)
sb.append("Tags: " + getTags() + ",");
if (getSnapshotArns() != null)
sb.append("SnapshotArns: " + getSnapshotArns() + ",");
if (getSnapshotName() != null)
sb.append("SnapshotName: " + getSnapshotName() + ",");
if (getPreferredMaintenanceWindow() != null)
sb.append("PreferredMaintenanceWindow: "
+ getPreferredMaintenanceWindow() + ",");
if (getPort() != null)
sb.append("Port: " + getPort() + ",");
if (getNotificationTopicArn() != null)
sb.append("NotificationTopicArn: " + getNotificationTopicArn()
+ ",");
if (getAutoMinorVersionUpgrade() != null)
sb.append("AutoMinorVersionUpgrade: "
+ getAutoMinorVersionUpgrade() + ",");
if (getSnapshotRetentionLimit() != null)
sb.append("SnapshotRetentionLimit: " + getSnapshotRetentionLimit()
+ ",");
if (getSnapshotWindow() != null)
sb.append("SnapshotWindow: " + getSnapshotWindow());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateCacheClusterRequest == false)
return false;
CreateCacheClusterRequest other = (CreateCacheClusterRequest) obj;
if (other.getCacheClusterId() == null
^ this.getCacheClusterId() == null)
return false;
if (other.getCacheClusterId() != null
&& other.getCacheClusterId().equals(this.getCacheClusterId()) == false)
return false;
if (other.getReplicationGroupId() == null
^ this.getReplicationGroupId() == null)
return false;
if (other.getReplicationGroupId() != null
&& other.getReplicationGroupId().equals(
this.getReplicationGroupId()) == false)
return false;
if (other.getAZMode() == null ^ this.getAZMode() == null)
return false;
if (other.getAZMode() != null
&& other.getAZMode().equals(this.getAZMode()) == false)
return false;
if (other.getPreferredAvailabilityZone() == null
^ this.getPreferredAvailabilityZone() == null)
return false;
if (other.getPreferredAvailabilityZone() != null
&& other.getPreferredAvailabilityZone().equals(
this.getPreferredAvailabilityZone()) == false)
return false;
if (other.getPreferredAvailabilityZones() == null
^ this.getPreferredAvailabilityZones() == null)
return false;
if (other.getPreferredAvailabilityZones() != null
&& other.getPreferredAvailabilityZones().equals(
this.getPreferredAvailabilityZones()) == false)
return false;
if (other.getNumCacheNodes() == null ^ this.getNumCacheNodes() == null)
return false;
if (other.getNumCacheNodes() != null
&& other.getNumCacheNodes().equals(this.getNumCacheNodes()) == false)
return false;
if (other.getCacheNodeType() == null ^ this.getCacheNodeType() == null)
return false;
if (other.getCacheNodeType() != null
&& other.getCacheNodeType().equals(this.getCacheNodeType()) == false)
return false;
if (other.getEngine() == null ^ this.getEngine() == null)
return false;
if (other.getEngine() != null
&& other.getEngine().equals(this.getEngine()) == false)
return false;
if (other.getEngineVersion() == null ^ this.getEngineVersion() == null)
return false;
if (other.getEngineVersion() != null
&& other.getEngineVersion().equals(this.getEngineVersion()) == false)
return false;
if (other.getCacheParameterGroupName() == null
^ this.getCacheParameterGroupName() == null)
return false;
if (other.getCacheParameterGroupName() != null
&& other.getCacheParameterGroupName().equals(
this.getCacheParameterGroupName()) == false)
return false;
if (other.getCacheSubnetGroupName() == null
^ this.getCacheSubnetGroupName() == null)
return false;
if (other.getCacheSubnetGroupName() != null
&& other.getCacheSubnetGroupName().equals(
this.getCacheSubnetGroupName()) == false)
return false;
if (other.getCacheSecurityGroupNames() == null
^ this.getCacheSecurityGroupNames() == null)
return false;
if (other.getCacheSecurityGroupNames() != null
&& other.getCacheSecurityGroupNames().equals(
this.getCacheSecurityGroupNames()) == false)
return false;
if (other.getSecurityGroupIds() == null
^ this.getSecurityGroupIds() == null)
return false;
if (other.getSecurityGroupIds() != null
&& other.getSecurityGroupIds().equals(
this.getSecurityGroupIds()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null
&& other.getTags().equals(this.getTags()) == false)
return false;
if (other.getSnapshotArns() == null ^ this.getSnapshotArns() == null)
return false;
if (other.getSnapshotArns() != null
&& other.getSnapshotArns().equals(this.getSnapshotArns()) == false)
return false;
if (other.getSnapshotName() == null ^ this.getSnapshotName() == null)
return false;
if (other.getSnapshotName() != null
&& other.getSnapshotName().equals(this.getSnapshotName()) == false)
return false;
if (other.getPreferredMaintenanceWindow() == null
^ this.getPreferredMaintenanceWindow() == null)
return false;
if (other.getPreferredMaintenanceWindow() != null
&& other.getPreferredMaintenanceWindow().equals(
this.getPreferredMaintenanceWindow()) == false)
return false;
if (other.getPort() == null ^ this.getPort() == null)
return false;
if (other.getPort() != null
&& other.getPort().equals(this.getPort()) == false)
return false;
if (other.getNotificationTopicArn() == null
^ this.getNotificationTopicArn() == null)
return false;
if (other.getNotificationTopicArn() != null
&& other.getNotificationTopicArn().equals(
this.getNotificationTopicArn()) == false)
return false;
if (other.getAutoMinorVersionUpgrade() == null
^ this.getAutoMinorVersionUpgrade() == null)
return false;
if (other.getAutoMinorVersionUpgrade() != null
&& other.getAutoMinorVersionUpgrade().equals(
this.getAutoMinorVersionUpgrade()) == false)
return false;
if (other.getSnapshotRetentionLimit() == null
^ this.getSnapshotRetentionLimit() == null)
return false;
if (other.getSnapshotRetentionLimit() != null
&& other.getSnapshotRetentionLimit().equals(
this.getSnapshotRetentionLimit()) == false)
return false;
if (other.getSnapshotWindow() == null
^ this.getSnapshotWindow() == null)
return false;
if (other.getSnapshotWindow() != null
&& other.getSnapshotWindow().equals(this.getSnapshotWindow()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getCacheClusterId() == null) ? 0 : getCacheClusterId()
.hashCode());
hashCode = prime
* hashCode
+ ((getReplicationGroupId() == null) ? 0
: getReplicationGroupId().hashCode());
hashCode = prime * hashCode
+ ((getAZMode() == null) ? 0 : getAZMode().hashCode());
hashCode = prime
* hashCode
+ ((getPreferredAvailabilityZone() == null) ? 0
: getPreferredAvailabilityZone().hashCode());
hashCode = prime
* hashCode
+ ((getPreferredAvailabilityZones() == null) ? 0
: getPreferredAvailabilityZones().hashCode());
hashCode = prime
* hashCode
+ ((getNumCacheNodes() == null) ? 0 : getNumCacheNodes()
.hashCode());
hashCode = prime
* hashCode
+ ((getCacheNodeType() == null) ? 0 : getCacheNodeType()
.hashCode());
hashCode = prime * hashCode
+ ((getEngine() == null) ? 0 : getEngine().hashCode());
hashCode = prime
* hashCode
+ ((getEngineVersion() == null) ? 0 : getEngineVersion()
.hashCode());
hashCode = prime
* hashCode
+ ((getCacheParameterGroupName() == null) ? 0
: getCacheParameterGroupName().hashCode());
hashCode = prime
* hashCode
+ ((getCacheSubnetGroupName() == null) ? 0
: getCacheSubnetGroupName().hashCode());
hashCode = prime
* hashCode
+ ((getCacheSecurityGroupNames() == null) ? 0
: getCacheSecurityGroupNames().hashCode());
hashCode = prime
* hashCode
+ ((getSecurityGroupIds() == null) ? 0 : getSecurityGroupIds()
.hashCode());
hashCode = prime * hashCode
+ ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime
* hashCode
+ ((getSnapshotArns() == null) ? 0 : getSnapshotArns()
.hashCode());
hashCode = prime
* hashCode
+ ((getSnapshotName() == null) ? 0 : getSnapshotName()
.hashCode());
hashCode = prime
* hashCode
+ ((getPreferredMaintenanceWindow() == null) ? 0
: getPreferredMaintenanceWindow().hashCode());
hashCode = prime * hashCode
+ ((getPort() == null) ? 0 : getPort().hashCode());
hashCode = prime
* hashCode
+ ((getNotificationTopicArn() == null) ? 0
: getNotificationTopicArn().hashCode());
hashCode = prime
* hashCode
+ ((getAutoMinorVersionUpgrade() == null) ? 0
: getAutoMinorVersionUpgrade().hashCode());
hashCode = prime
* hashCode
+ ((getSnapshotRetentionLimit() == null) ? 0
: getSnapshotRetentionLimit().hashCode());
hashCode = prime
* hashCode
+ ((getSnapshotWindow() == null) ? 0 : getSnapshotWindow()
.hashCode());
return hashCode;
}
@Override
public CreateCacheClusterRequest clone() {
return (CreateCacheClusterRequest) super.clone();
}
}