software.amazon.awssdk.services.cloudhsmv2.model

Class CreateClusterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudhsmv2.model.CloudHsmV2Request

software.amazon.awssdk.services.cloudhsmv2.model.CreateClusterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateClusterRequest
extends CloudHsmV2Request
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
static CreateClusterRequest.Builder	builder()
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	hsmType() The type of HSM to use in the cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateClusterRequest.Builder>	serializableBuilderClass()
String	sourceBackupId() The identifier (ID) of the cluster backup to restore.
List<String>	subnetIds() The identifiers (IDs) of the subnets where you are creating the 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.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

subnetIds

public List<String> subnetIds()

The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

• All subnets must be in the same virtual private cloud (VPC).

• You can specify only one subnet per Availability Zone.

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

Returns:

The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

• All subnets must be in the same virtual private cloud (VPC).

• You can specify only one subnet per Availability Zone.

hsmType

public String hsmType()

The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.

Returns:

The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.

sourceBackupId

public String sourceBackupId()

The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.

Returns:

The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.

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>

Specified by:

toBuilder in class CloudHsmV2Request

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

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.