@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateClusterRequest() |
Modifier and Type | Method and Description |
---|---|
CreateClusterRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getAvailabilityZones()
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated.
|
String |
getClusterEndpointEncryptionType()
The type of encryption the cluster's endpoint should support.
|
String |
getClusterName()
The cluster identifier.
|
String |
getDescription()
A description of the cluster.
|
String |
getIamRoleArn()
A valid Amazon Resource Name (ARN) that identifies an IAM role.
|
String |
getNodeType()
The compute and memory capacity of the nodes in the cluster.
|
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
|
String |
getParameterGroupName()
The parameter group to be associated with the DAX cluster.
|
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the DAX cluster is performed.
|
Integer |
getReplicationFactor()
The number of nodes in the DAX cluster.
|
List<String> |
getSecurityGroupIds()
A list of security group IDs to be assigned to each node in the DAX cluster.
|
SSESpecification |
getSSESpecification()
Represents the settings used to enable server-side encryption on the cluster.
|
String |
getSubnetGroupName()
The name of the subnet group to be used for the replication group.
|
List<Tag> |
getTags()
A set of tags to associate with the DAX cluster.
|
int |
hashCode() |
void |
setAvailabilityZones(Collection<String> availabilityZones)
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated.
|
void |
setClusterEndpointEncryptionType(String clusterEndpointEncryptionType)
The type of encryption the cluster's endpoint should support.
|
void |
setClusterName(String clusterName)
The cluster identifier.
|
void |
setDescription(String description)
A description of the cluster.
|
void |
setIamRoleArn(String iamRoleArn)
A valid Amazon Resource Name (ARN) that identifies an IAM role.
|
void |
setNodeType(String nodeType)
The compute and memory capacity of the nodes in the cluster.
|
void |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
|
void |
setParameterGroupName(String parameterGroupName)
The parameter group to be associated with the DAX cluster.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the DAX cluster is performed.
|
void |
setReplicationFactor(Integer replicationFactor)
The number of nodes in the DAX cluster.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
A list of security group IDs to be assigned to each node in the DAX cluster.
|
void |
setSSESpecification(SSESpecification sSESpecification)
Represents the settings used to enable server-side encryption on the cluster.
|
void |
setSubnetGroupName(String subnetGroupName)
The name of the subnet group to be used for the replication group.
|
void |
setTags(Collection<Tag> tags)
A set of tags to associate with the DAX cluster.
|
String |
toString()
Returns a string representation of this object.
|
CreateClusterRequest |
withAvailabilityZones(Collection<String> availabilityZones)
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated.
|
CreateClusterRequest |
withAvailabilityZones(String... availabilityZones)
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated.
|
CreateClusterRequest |
withClusterEndpointEncryptionType(ClusterEndpointEncryptionType clusterEndpointEncryptionType)
The type of encryption the cluster's endpoint should support.
|
CreateClusterRequest |
withClusterEndpointEncryptionType(String clusterEndpointEncryptionType)
The type of encryption the cluster's endpoint should support.
|
CreateClusterRequest |
withClusterName(String clusterName)
The cluster identifier.
|
CreateClusterRequest |
withDescription(String description)
A description of the cluster.
|
CreateClusterRequest |
withIamRoleArn(String iamRoleArn)
A valid Amazon Resource Name (ARN) that identifies an IAM role.
|
CreateClusterRequest |
withNodeType(String nodeType)
The compute and memory capacity of the nodes in the cluster.
|
CreateClusterRequest |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
|
CreateClusterRequest |
withParameterGroupName(String parameterGroupName)
The parameter group to be associated with the DAX cluster.
|
CreateClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the DAX cluster is performed.
|
CreateClusterRequest |
withReplicationFactor(Integer replicationFactor)
The number of nodes in the DAX cluster.
|
CreateClusterRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
A list of security group IDs to be assigned to each node in the DAX cluster.
|
CreateClusterRequest |
withSecurityGroupIds(String... securityGroupIds)
A list of security group IDs to be assigned to each node in the DAX cluster.
|
CreateClusterRequest |
withSSESpecification(SSESpecification sSESpecification)
Represents the settings used to enable server-side encryption on the cluster.
|
CreateClusterRequest |
withSubnetGroupName(String subnetGroupName)
The name of the subnet group to be used for the replication group.
|
CreateClusterRequest |
withTags(Collection<Tag> tags)
A set of tags to associate with the DAX cluster.
|
CreateClusterRequest |
withTags(Tag... tags)
A set of tags to associate with the DAX cluster.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setClusterName(String clusterName)
The cluster 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.
clusterName
- The cluster 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 getClusterName()
The cluster 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.
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 CreateClusterRequest withClusterName(String clusterName)
The cluster 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.
clusterName
- The cluster 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 setNodeType(String nodeType)
The compute and memory capacity of the nodes in the cluster.
nodeType
- The compute and memory capacity of the nodes in the cluster.public String getNodeType()
The compute and memory capacity of the nodes in the cluster.
public CreateClusterRequest withNodeType(String nodeType)
The compute and memory capacity of the nodes in the cluster.
nodeType
- The compute and memory capacity of the nodes in the cluster.public void setDescription(String description)
A description of the cluster.
description
- A description of the cluster.public String getDescription()
A description of the cluster.
public CreateClusterRequest withDescription(String description)
A description of the cluster.
description
- A description of the cluster.public void setReplicationFactor(Integer replicationFactor)
The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any
read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read
replicas. To do this, set ReplicationFactor
to a number between 3 (one primary and two read
replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones
parameter is
provided, its length must equal the ReplicationFactor
.
AWS recommends that you have at least two read replicas per cluster.
replicationFactor
- The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster,
without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one
or more read replicas. To do this, set ReplicationFactor
to a number between 3 (one primary
and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones
parameter is provided, its length must equal the ReplicationFactor
. AWS recommends that you have at least two read replicas per cluster.
public Integer getReplicationFactor()
The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any
read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read
replicas. To do this, set ReplicationFactor
to a number between 3 (one primary and two read
replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones
parameter is
provided, its length must equal the ReplicationFactor
.
AWS recommends that you have at least two read replicas per cluster.
ReplicationFactor
to a number between 3 (one
primary and two read replicas) and 10 (one primary and nine read replicas).
If the AvailabilityZones
parameter is provided, its length must equal the
ReplicationFactor
. AWS recommends that you have at least two read replicas per cluster.
public CreateClusterRequest withReplicationFactor(Integer replicationFactor)
The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any
read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read
replicas. To do this, set ReplicationFactor
to a number between 3 (one primary and two read
replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones
parameter is
provided, its length must equal the ReplicationFactor
.
AWS recommends that you have at least two read replicas per cluster.
replicationFactor
- The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster,
without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one
or more read replicas. To do this, set ReplicationFactor
to a number between 3 (one primary
and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones
parameter is provided, its length must equal the ReplicationFactor
. AWS recommends that you have at least two read replicas per cluster.
public List<String> getAvailabilityZones()
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated. If provided, the length of this list must equal the ReplicationFactor
parameter. If you
omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
ReplicationFactor
parameter. If
you omit this parameter, DAX will spread the nodes across Availability Zones for the highest
availability.public void setAvailabilityZones(Collection<String> availabilityZones)
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated. If provided, the length of this list must equal the ReplicationFactor
parameter. If you
omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
availabilityZones
- The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated. If provided, the length of this list must equal the ReplicationFactor
parameter. If
you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.public CreateClusterRequest withAvailabilityZones(String... availabilityZones)
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated. If provided, the length of this list must equal the ReplicationFactor
parameter. If you
omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
NOTE: This method appends the values to the existing list (if any). Use
setAvailabilityZones(java.util.Collection)
or withAvailabilityZones(java.util.Collection)
if
you want to override the existing values.
availabilityZones
- The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated. If provided, the length of this list must equal the ReplicationFactor
parameter. If
you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.public CreateClusterRequest withAvailabilityZones(Collection<String> availabilityZones)
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated. If provided, the length of this list must equal the ReplicationFactor
parameter. If you
omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
availabilityZones
- The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
updated. If provided, the length of this list must equal the ReplicationFactor
parameter. If
you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.public void setSubnetGroupName(String subnetGroupName)
The name of the subnet group to be used for the replication group.
DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
subnetGroupName
- The name of the subnet group to be used for the replication group. DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
public String getSubnetGroupName()
The name of the subnet group to be used for the replication group.
DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
public CreateClusterRequest withSubnetGroupName(String subnetGroupName)
The name of the subnet group to be used for the replication group.
DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
subnetGroupName
- The name of the subnet group to be used for the replication group. DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
public List<String> getSecurityGroupIds()
A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)
If this parameter is not specified, DAX assigns the default VPC security group to each node.
If this parameter is not specified, DAX assigns the default VPC security group to each node.
public void setSecurityGroupIds(Collection<String> securityGroupIds)
A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)
If this parameter is not specified, DAX assigns the default VPC security group to each node.
securityGroupIds
- A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group
ID is system-generated.)
If this parameter is not specified, DAX assigns the default VPC security group to each node.
public CreateClusterRequest withSecurityGroupIds(String... securityGroupIds)
A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)
If this parameter is not specified, DAX assigns the default VPC security group to each node.
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroupIds(java.util.Collection)
or withSecurityGroupIds(java.util.Collection)
if you
want to override the existing values.
securityGroupIds
- A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group
ID is system-generated.)
If this parameter is not specified, DAX assigns the default VPC security group to each node.
public CreateClusterRequest withSecurityGroupIds(Collection<String> securityGroupIds)
A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)
If this parameter is not specified, DAX assigns the default VPC security group to each node.
securityGroupIds
- A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group
ID is system-generated.)
If this parameter is not specified, DAX assigns the default VPC security group to each node.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the DAX 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
If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the DAX 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
If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
public String getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the DAX 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
If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
public CreateClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the DAX 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
If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the DAX 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
If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
public void setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
The Amazon SNS topic owner must be same as the DAX cluster owner.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. The Amazon SNS topic owner must be same as the DAX cluster owner.
public String getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
The Amazon SNS topic owner must be same as the DAX cluster owner.
The Amazon SNS topic owner must be same as the DAX cluster owner.
public CreateClusterRequest withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
The Amazon SNS topic owner must be same as the DAX cluster owner.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. The Amazon SNS topic owner must be same as the DAX cluster owner.
public void setIamRoleArn(String iamRoleArn)
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
iamRoleArn
- A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and
use the role's permissions to access DynamoDB on your behalf.public String getIamRoleArn()
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
public CreateClusterRequest withIamRoleArn(String iamRoleArn)
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
iamRoleArn
- A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and
use the role's permissions to access DynamoDB on your behalf.public void setParameterGroupName(String parameterGroupName)
The parameter group to be associated with the DAX cluster.
parameterGroupName
- The parameter group to be associated with the DAX cluster.public String getParameterGroupName()
The parameter group to be associated with the DAX cluster.
public CreateClusterRequest withParameterGroupName(String parameterGroupName)
The parameter group to be associated with the DAX cluster.
parameterGroupName
- The parameter group to be associated with the DAX cluster.public List<Tag> getTags()
A set of tags to associate with the DAX cluster.
public void setTags(Collection<Tag> tags)
A set of tags to associate with the DAX cluster.
tags
- A set of tags to associate with the DAX cluster.public CreateClusterRequest withTags(Tag... tags)
A set of tags to associate with the DAX cluster.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- A set of tags to associate with the DAX cluster.public CreateClusterRequest withTags(Collection<Tag> tags)
A set of tags to associate with the DAX cluster.
tags
- A set of tags to associate with the DAX cluster.public void setSSESpecification(SSESpecification sSESpecification)
Represents the settings used to enable server-side encryption on the cluster.
sSESpecification
- Represents the settings used to enable server-side encryption on the cluster.public SSESpecification getSSESpecification()
Represents the settings used to enable server-side encryption on the cluster.
public CreateClusterRequest withSSESpecification(SSESpecification sSESpecification)
Represents the settings used to enable server-side encryption on the cluster.
sSESpecification
- Represents the settings used to enable server-side encryption on the cluster.public void setClusterEndpointEncryptionType(String clusterEndpointEncryptionType)
The type of encryption the cluster's endpoint should support. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
clusterEndpointEncryptionType
- The type of encryption the cluster's endpoint should support. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
ClusterEndpointEncryptionType
public String getClusterEndpointEncryptionType()
The type of encryption the cluster's endpoint should support. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
NONE
for no encryption
TLS
for Transport Layer Security
ClusterEndpointEncryptionType
public CreateClusterRequest withClusterEndpointEncryptionType(String clusterEndpointEncryptionType)
The type of encryption the cluster's endpoint should support. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
clusterEndpointEncryptionType
- The type of encryption the cluster's endpoint should support. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
ClusterEndpointEncryptionType
public CreateClusterRequest withClusterEndpointEncryptionType(ClusterEndpointEncryptionType clusterEndpointEncryptionType)
The type of encryption the cluster's endpoint should support. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
clusterEndpointEncryptionType
- The type of encryption the cluster's endpoint should support. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
ClusterEndpointEncryptionType
public String toString()
toString
in class Object
Object.toString()
public CreateClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()