@Generated(value="software.amazon.awssdk:codegen") public final class CreateClusterRequest extends DaxRequest implements ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateClusterRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<String> |
availabilityZones()
The Availability Zones (AZs) in which the cluster nodes will be created.
|
static CreateClusterRequest.Builder |
builder() |
String |
clusterName()
The cluster identifier.
|
String |
description()
A description of the cluster.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
iamRoleArn()
A valid Amazon Resource Name (ARN) that identifies an IAM role.
|
String |
nodeType()
The compute and memory capacity of the nodes in the cluster.
|
String |
notificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
|
String |
parameterGroupName()
The parameter group to be associated with the DAX cluster.
|
String |
preferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the DAX cluster is performed.
|
Integer |
replicationFactor()
The number of nodes in the DAX cluster.
|
List<String> |
securityGroupIds()
A list of security group IDs to be assigned to each node in the DAX cluster.
|
static Class<? extends CreateClusterRequest.Builder> |
serializableBuilderClass() |
String |
subnetGroupName()
The name of the subnet group to be used for the replication group.
|
List<Tag> |
tags()
A set of tags to associate with the DAX cluster.
|
CreateClusterRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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.
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 nodeType()
The compute and memory capacity of the nodes in the cluster.
public String description()
A description of the cluster.
public 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 2 or more.
AWS recommends that you have at least two read replicas per cluster.
AWS recommends that you have at least two read replicas per cluster.
public List<String> availabilityZones()
The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
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> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
If this parameter is not specified, DAX assigns the default VPC security group to each node.
public 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.
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 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.
The Amazon SNS topic owner must be same as the DAX cluster owner.
public 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.
public String parameterGroupName()
The parameter group to be associated with the DAX cluster.
public List<Tag> tags()
A set of tags to associate with the DAX cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public CreateClusterRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
toBuilder
in class DaxRequest
public static CreateClusterRequest.Builder builder()
public static Class<? extends CreateClusterRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.