Package software.amazon.awssdk.services.dax.model

Class CreateClusterRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.dax.model.CreateClusterRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateClusterRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateClusterRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	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)
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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

clusterName

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.

Returns:

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.

nodeType

public String nodeType()

The compute and memory capacity of the nodes in the cluster.

Returns:

The compute and memory capacity of the nodes in the cluster.

description

public String description()

A description of the cluster.

Returns:

A description of the cluster.

replicationFactor

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.

Returns:

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.

availabilityZones

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.

Returns:

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.

subnetGroupName

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.

Returns:

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.

securityGroupIds

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.

Returns:

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.

preferredMaintenanceWindow

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.

Returns:

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.

notificationTopicArn

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.

Returns:

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.

iamRoleArn

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.

Returns:

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.

parameterGroupName

public String parameterGroupName()

The parameter group to be associated with the DAX cluster.

Returns:

The parameter group to be associated with the DAX cluster.

tags

public List<Tag> tags()

A set of tags to associate with the DAX cluster.

Returns:

A set of tags to associate with the DAX cluster.

toBuilder

public CreateClusterRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

Returns:

a builder for type T

builder

public static CreateClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateClusterRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object