software.amazon.awssdk.services.dax.model

Class CreateClusterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.dax.model.DaxRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateClusterRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	availabilityZones() The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
static CreateClusterRequest.Builder	builder()
ClusterEndpointEncryptionType	clusterEndpointEncryptionType() The type of encryption the cluster's endpoint should support.
String	clusterEndpointEncryptionTypeAsString() The type of encryption the cluster's endpoint should support.
String	clusterName() The cluster identifier.
String	description() A description of the cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAvailabilityZones() For responses, this returns true if the service returned a value for the AvailabilityZones property.
int	hashCode()
boolean	hasSecurityGroupIds() For responses, this returns true if the service returned a value for the SecurityGroupIds property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
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<SdkField<?>>	sdkFields()
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()
SSESpecification	sseSpecification() Represents the settings used to enable server-side encryption on the cluster.
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()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clusterName

public final 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 final 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 final String description()

A description of the cluster.

Returns:

A description of the cluster.

replicationFactor

public final 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.

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 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.

hasAvailabilityZones

public final boolean hasAvailabilityZones()

For responses, this returns true if the service returned a value for the AvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

availabilityZones

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAvailabilityZones() method.

Returns:

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.

subnetGroupName

public final 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.

hasSecurityGroupIds

public final boolean hasSecurityGroupIds()

For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

securityGroupIds

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

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 final 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 final 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 final 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 final String parameterGroupName()

The parameter group to be associated with the DAX cluster.

Returns:

The parameter group to be associated with the DAX cluster.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A set of tags to associate with the DAX cluster.

sseSpecification

public final SSESpecification sseSpecification()

Represents the settings used to enable server-side encryption on the cluster.

Returns:

Represents the settings used to enable server-side encryption on the cluster.

clusterEndpointEncryptionType

public final ClusterEndpointEncryptionType clusterEndpointEncryptionType()

The type of encryption the cluster's endpoint should support. Values are:

• NONE for no encryption

• TLS for Transport Layer Security

If the service returns an enum value that is not available in the current SDK version, clusterEndpointEncryptionType will return ClusterEndpointEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterEndpointEncryptionTypeAsString().

Returns:

The type of encryption the cluster's endpoint should support. Values are:

• NONE for no encryption

• TLS for Transport Layer Security

See Also:

ClusterEndpointEncryptionType

clusterEndpointEncryptionTypeAsString

public final String clusterEndpointEncryptionTypeAsString()

The type of encryption the cluster's endpoint should support. Values are:

• NONE for no encryption

• TLS for Transport Layer Security

If the service returns an enum value that is not available in the current SDK version, clusterEndpointEncryptionType will return ClusterEndpointEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterEndpointEncryptionTypeAsString().

Returns:

The type of encryption the cluster's endpoint should support. Values are:

• NONE for no encryption

• TLS for Transport Layer Security

See Also:

ClusterEndpointEncryptionType

toBuilder

public CreateClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

Specified by:

toBuilder in class DaxRequest

builder

public static CreateClusterRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo