|
Did this page help you?Yes No Tell us about it... |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.elasticache.model.CreateCacheClusterRequest
public class CreateCacheClusterRequest
Container for the parameters to the CreateCacheCluster operation
.
Creates a new Cache Cluster.
AmazonElastiCache.createCacheCluster(CreateCacheClusterRequest)
,
Serialized FormConstructor Summary | |
---|---|
CreateCacheClusterRequest()
Default constructor for a new CreateCacheClusterRequest object. |
|
CreateCacheClusterRequest(String cacheClusterId,
Integer numCacheNodes,
String cacheNodeType,
String engine,
List<String> cacheSecurityGroupNames)
Constructs a new CreateCacheClusterRequest object. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
Boolean |
getAutoMinorVersionUpgrade()
Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window. |
String |
getCacheClusterId()
The Cache Cluster identifier. |
String |
getCacheNodeType()
The compute and memory capacity of nodes in a Cache Cluster. |
String |
getCacheParameterGroupName()
The name of the cache parameter group to associate with this Cache cluster. |
List<String> |
getCacheSecurityGroupNames()
A list of Cache Security Group Names to associate with this Cache Cluster. |
String |
getCacheSubnetGroupName()
The name of the Cache Subnet Group to be used for the Cache Cluster. |
String |
getEngine()
The name of the cache engine to be used for this Cache Cluster. |
String |
getEngineVersion()
The version of the cache engine to be used for this cluster. |
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. |
Integer |
getNumCacheNodes()
The number of Cache Nodes the Cache Cluster should have. |
Integer |
getPort()
The port number on which each of the Cache Nodes will accept connections. |
String |
getPreferredAvailabilityZone()
The EC2 Availability Zone that the Cache Cluster will be created in. |
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can occur. |
List<String> |
getSecurityGroupIds()
Specifies the VPC Security Groups associated with the Cache Cluster. |
int |
hashCode()
|
Boolean |
isAutoMinorVersionUpgrade()
Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window. |
void |
setCacheClusterId(String cacheClusterId)
The Cache Cluster identifier. |
void |
setCacheNodeType(String cacheNodeType)
The compute and memory capacity of nodes in a Cache Cluster. |
void |
setCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to associate with this Cache cluster. |
void |
setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of Cache Security Group Names to associate with this Cache Cluster. |
void |
setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the Cache Subnet Group to be used for the Cache Cluster. |
void |
setEngine(String engine)
The name of the cache engine to be used for this Cache Cluster. |
void |
setEngineVersion(String engineVersion)
The version of the cache engine to be used for this cluster. |
void |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. |
void |
setNumCacheNodes(Integer numCacheNodes)
The number of Cache Nodes the Cache Cluster should have. |
void |
setPort(Integer port)
The port number on which each of the Cache Nodes will accept connections. |
void |
setPreferredAvailabilityZone(String preferredAvailabilityZone)
The EC2 Availability Zone that the Cache Cluster will be created in. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur. |
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the Cache Cluster. |
String |
toString()
Returns a string representation of this object; useful for testing and debugging. |
CreateCacheClusterRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window. |
CreateCacheClusterRequest |
withCacheClusterId(String cacheClusterId)
The Cache Cluster identifier. |
CreateCacheClusterRequest |
withCacheNodeType(String cacheNodeType)
The compute and memory capacity of nodes in a Cache Cluster. |
CreateCacheClusterRequest |
withCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to associate with this Cache cluster. |
CreateCacheClusterRequest |
withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of Cache Security Group Names to associate with this Cache Cluster. |
CreateCacheClusterRequest |
withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of Cache Security Group Names to associate with this Cache Cluster. |
CreateCacheClusterRequest |
withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the Cache Subnet Group to be used for the Cache Cluster. |
CreateCacheClusterRequest |
withEngine(String engine)
The name of the cache engine to be used for this Cache Cluster. |
CreateCacheClusterRequest |
withEngineVersion(String engineVersion)
The version of the cache engine to be used for this cluster. |
CreateCacheClusterRequest |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. |
CreateCacheClusterRequest |
withNumCacheNodes(Integer numCacheNodes)
The number of Cache Nodes the Cache Cluster should have. |
CreateCacheClusterRequest |
withPort(Integer port)
The port number on which each of the Cache Nodes will accept connections. |
CreateCacheClusterRequest |
withPreferredAvailabilityZone(String preferredAvailabilityZone)
The EC2 Availability Zone that the Cache Cluster will be created in. |
CreateCacheClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur. |
CreateCacheClusterRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the Cache Cluster. |
CreateCacheClusterRequest |
withSecurityGroupIds(String... securityGroupIds)
Specifies the VPC Security Groups associated with the Cache Cluster. |
Methods inherited from class com.amazonaws.AmazonWebServiceRequest |
---|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CreateCacheClusterRequest()
public CreateCacheClusterRequest(String cacheClusterId, Integer numCacheNodes, String cacheNodeType, String engine, List<String> cacheSecurityGroupNames)
cacheClusterId
- The Cache Cluster identifier. This parameter is
stored as a lowercase string. Constraints:
Example:
mycachecluster
numCacheNodes
- The number of Cache Nodes the Cache Cluster
should have.cacheNodeType
- The compute and memory capacity of nodes in a
Cache Cluster. Valid values: cache.t1.micro
|
cache.m1.small
| cache.m1.medium
|
cache.m1.large
| cache.m1.xlarge
|
cache.m3.xlarge
| cache.m3.2xlarge
|
cache.m2.xlarge
| cache.m2.2xlarge
|
cache.m2.4xlarge
| cache.c1.xlarge
engine
- The name of the cache engine to be used for this Cache
Cluster. cacheSecurityGroupNames
- A list of Cache Security Group Names to
associate with this Cache Cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
Method Detail |
---|
public String getCacheClusterId()
Constraints:
Example: mycachecluster
Constraints:
Example: mycachecluster
public void setCacheClusterId(String cacheClusterId)
Constraints:
Example: mycachecluster
cacheClusterId
- The Cache Cluster identifier. This parameter is stored as a lowercase
string. Constraints:
Example: mycachecluster
public CreateCacheClusterRequest withCacheClusterId(String cacheClusterId)
Constraints:
Example: mycachecluster
Returns a reference to this object so that method calls can be chained together.
cacheClusterId
- The Cache Cluster identifier. This parameter is stored as a lowercase
string. Constraints:
Example: mycachecluster
public Integer getNumCacheNodes()
public void setNumCacheNodes(Integer numCacheNodes)
numCacheNodes
- The number of Cache Nodes the Cache Cluster should have.public CreateCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)
Returns a reference to this object so that method calls can be chained together.
numCacheNodes
- The number of Cache Nodes the Cache Cluster should have.
public String getCacheNodeType()
Valid
values: cache.t1.micro
| cache.m1.small
|
cache.m1.medium
| cache.m1.large
|
cache.m1.xlarge
| cache.m3.xlarge
|
cache.m3.2xlarge
| cache.m2.xlarge
|
cache.m2.2xlarge
| cache.m2.4xlarge
|
cache.c1.xlarge
Valid
values: cache.t1.micro
| cache.m1.small
|
cache.m1.medium
| cache.m1.large
|
cache.m1.xlarge
| cache.m3.xlarge
|
cache.m3.2xlarge
| cache.m2.xlarge
|
cache.m2.2xlarge
| cache.m2.4xlarge
|
cache.c1.xlarge
public void setCacheNodeType(String cacheNodeType)
Valid
values: cache.t1.micro
| cache.m1.small
|
cache.m1.medium
| cache.m1.large
|
cache.m1.xlarge
| cache.m3.xlarge
|
cache.m3.2xlarge
| cache.m2.xlarge
|
cache.m2.2xlarge
| cache.m2.4xlarge
|
cache.c1.xlarge
cacheNodeType
- The compute and memory capacity of nodes in a Cache Cluster. Valid
values: cache.t1.micro
| cache.m1.small
|
cache.m1.medium
| cache.m1.large
|
cache.m1.xlarge
| cache.m3.xlarge
|
cache.m3.2xlarge
| cache.m2.xlarge
|
cache.m2.2xlarge
| cache.m2.4xlarge
|
cache.c1.xlarge
public CreateCacheClusterRequest withCacheNodeType(String cacheNodeType)
Valid
values: cache.t1.micro
| cache.m1.small
|
cache.m1.medium
| cache.m1.large
|
cache.m1.xlarge
| cache.m3.xlarge
|
cache.m3.2xlarge
| cache.m2.xlarge
|
cache.m2.2xlarge
| cache.m2.4xlarge
|
cache.c1.xlarge
Returns a reference to this object so that method calls can be chained together.
cacheNodeType
- The compute and memory capacity of nodes in a Cache Cluster. Valid
values: cache.t1.micro
| cache.m1.small
|
cache.m1.medium
| cache.m1.large
|
cache.m1.xlarge
| cache.m3.xlarge
|
cache.m3.2xlarge
| cache.m2.xlarge
|
cache.m2.2xlarge
| cache.m2.4xlarge
|
cache.c1.xlarge
public String getEngine()
public void setEngine(String engine)
engine
- The name of the cache engine to be used for this Cache Cluster.
public CreateCacheClusterRequest withEngine(String engine)
Returns a reference to this object so that method calls can be chained together.
engine
- The name of the cache engine to be used for this Cache Cluster.
public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- The version of the cache engine to be used for this cluster.public CreateCacheClusterRequest withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- The version of the cache engine to be used for this cluster.
public String getCacheParameterGroupName()
public void setCacheParameterGroupName(String cacheParameterGroupName)
cacheParameterGroupName
- The name of the cache parameter group to associate with this Cache
cluster. If this argument is omitted, the default CacheParameterGroup
for the specified engine will be used.public CreateCacheClusterRequest withCacheParameterGroupName(String cacheParameterGroupName)
Returns a reference to this object so that method calls can be chained together.
cacheParameterGroupName
- The name of the cache parameter group to associate with this Cache
cluster. If this argument is omitted, the default CacheParameterGroup
for the specified engine will be used.
public String getCacheSubnetGroupName()
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public void setCacheSubnetGroupName(String cacheSubnetGroupName)
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
cacheSubnetGroupName
- The name of the Cache Subnet Group to be used for the Cache Cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withCacheSubnetGroupName(String cacheSubnetGroupName)
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
cacheSubnetGroupName
- The name of the Cache Subnet Group to be used for the Cache Cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public List<String> getCacheSecurityGroupNames()
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
cacheSecurityGroupNames
- A list of Cache Security Group Names to associate with this Cache
Cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
cacheSecurityGroupNames
- A list of Cache Security Group Names to associate with this Cache
Cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
cacheSecurityGroupNames
- A list of Cache Security Group Names to associate with this Cache
Cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
public List<String> getSecurityGroupIds()
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public void setSecurityGroupIds(Collection<String> securityGroupIds)
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
securityGroupIds
- Specifies the VPC Security Groups associated with the Cache Cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withSecurityGroupIds(String... securityGroupIds)
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
securityGroupIds
- Specifies the VPC Security Groups associated with the Cache Cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public CreateCacheClusterRequest withSecurityGroupIds(Collection<String> securityGroupIds)
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
securityGroupIds
- Specifies the VPC Security Groups associated with the Cache Cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
public String getPreferredAvailabilityZone()
All cache nodes belonging to a cache cluster are placed in the preferred availability zone.
Default: System chosen (random) availability zone.
All cache nodes belonging to a cache cluster are placed in the preferred availability zone.
Default: System chosen (random) availability zone.
public void setPreferredAvailabilityZone(String preferredAvailabilityZone)
All cache nodes belonging to a cache cluster are placed in the preferred availability zone.
Default: System chosen (random) availability zone.
preferredAvailabilityZone
- The EC2 Availability Zone that the Cache Cluster will be created in.
All cache nodes belonging to a cache cluster are placed in the preferred availability zone.
Default: System chosen (random) availability zone.
public CreateCacheClusterRequest withPreferredAvailabilityZone(String preferredAvailabilityZone)
All cache nodes belonging to a cache cluster are placed in the preferred availability zone.
Default: System chosen (random) availability zone.
Returns a reference to this object so that method calls can be chained together.
preferredAvailabilityZone
- The EC2 Availability Zone that the Cache Cluster will be created in.
All cache nodes belonging to a cache cluster are placed in the preferred availability zone.
Default: System chosen (random) availability zone.
public String getPreferredMaintenanceWindow()
Example: sun:05:00-sun:09:00
Example: sun:05:00-sun:09:00
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Example: sun:05:00-sun:09:00
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur. Example: sun:05:00-sun:09:00
public CreateCacheClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Example: sun:05:00-sun:09:00
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur. Example: sun:05:00-sun:09:00
public Integer getPort()
public void setPort(Integer port)
port
- The port number on which each of the Cache Nodes will accept
connections.public CreateCacheClusterRequest withPort(Integer port)
Returns a reference to this object so that method calls can be chained together.
port
- The port number on which each of the Cache Nodes will accept
connections.
public String getNotificationTopicArn()
public void setNotificationTopicArn(String notificationTopicArn)
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent. public CreateCacheClusterRequest withNotificationTopicArn(String notificationTopicArn)
Returns a reference to this object so that method calls can be chained together.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification
Service (SNS) topic to which notifications will be sent. public Boolean isAutoMinorVersionUpgrade()
Default:
true
Default:
true
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Default:
true
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to
the Cache Cluster during the maintenance window. Default:
true
public CreateCacheClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Default:
true
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to
the Cache Cluster during the maintenance window. Default:
true
public Boolean getAutoMinorVersionUpgrade()
Default:
true
Default:
true
public String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |