com.amazonaws.services.cloudhsmv2.model

Class CreateClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudhsmv2.model.CreateClusterRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateClusterRequest()

Method Summary

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)
BackupRetentionPolicy	getBackupRetentionPolicy() A policy that defines how the service retains backups.
String	getHsmType() The type of HSM to use in the cluster.
String	getMode() The mode to use in the cluster.
String	getSourceBackupId() The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore.
List<String>	getSubnetIds() The identifiers (IDs) of the subnets where you are creating the cluster.
List<Tag>	getTagList() Tags to apply to the CloudHSM cluster during creation.
int	hashCode()
void	setBackupRetentionPolicy(BackupRetentionPolicy backupRetentionPolicy) A policy that defines how the service retains backups.
void	setHsmType(String hsmType) The type of HSM to use in the cluster.
void	setMode(String mode) The mode to use in the cluster.
void	setSourceBackupId(String sourceBackupId) The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore.
void	setSubnetIds(Collection<String> subnetIds) The identifiers (IDs) of the subnets where you are creating the cluster.
void	setTagList(Collection<Tag> tagList) Tags to apply to the CloudHSM cluster during creation.
String	toString() Returns a string representation of this object.
CreateClusterRequest	withBackupRetentionPolicy(BackupRetentionPolicy backupRetentionPolicy) A policy that defines how the service retains backups.
CreateClusterRequest	withHsmType(String hsmType) The type of HSM to use in the cluster.
CreateClusterRequest	withMode(ClusterMode mode) The mode to use in the cluster.
CreateClusterRequest	withMode(String mode) The mode to use in the cluster.
CreateClusterRequest	withSourceBackupId(String sourceBackupId) The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore.
CreateClusterRequest	withSubnetIds(Collection<String> subnetIds) The identifiers (IDs) of the subnets where you are creating the cluster.
CreateClusterRequest	withSubnetIds(String... subnetIds) The identifiers (IDs) of the subnets where you are creating the cluster.
CreateClusterRequest	withTagList(Collection<Tag> tagList) Tags to apply to the CloudHSM cluster during creation.
CreateClusterRequest	withTagList(Tag... tagList) Tags to apply to the CloudHSM cluster during creation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateClusterRequest

public CreateClusterRequest()

Method Detail

setBackupRetentionPolicy

public void setBackupRetentionPolicy(BackupRetentionPolicy backupRetentionPolicy)

A policy that defines how the service retains backups.

Parameters:

backupRetentionPolicy - A policy that defines how the service retains backups.

getBackupRetentionPolicy

public BackupRetentionPolicy getBackupRetentionPolicy()

A policy that defines how the service retains backups.

Returns:

A policy that defines how the service retains backups.

withBackupRetentionPolicy

public CreateClusterRequest withBackupRetentionPolicy(BackupRetentionPolicy backupRetentionPolicy)

A policy that defines how the service retains backups.

Parameters:

backupRetentionPolicy - A policy that defines how the service retains backups.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHsmType

public void setHsmType(String hsmType)

The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

Parameters:

hsmType - The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

getHsmType

public String getHsmType()

The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

Returns:

The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

withHsmType

public CreateClusterRequest withHsmType(String hsmType)

The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

Parameters:

hsmType - The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceBackupId

public void setSourceBackupId(String sourceBackupId)

The identifier (ID) or the Amazon Resource Name (ARN) 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 or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

Parameters:

sourceBackupId - The identifier (ID) or the Amazon Resource Name (ARN) 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 or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

getSourceBackupId

public String getSourceBackupId()

The identifier (ID) or the Amazon Resource Name (ARN) 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 or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

Returns:

The identifier (ID) or the Amazon Resource Name (ARN) 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 or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

withSourceBackupId

public CreateClusterRequest withSourceBackupId(String sourceBackupId)

The identifier (ID) or the Amazon Resource Name (ARN) 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 or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

Parameters:

sourceBackupId - The identifier (ID) or the Amazon Resource Name (ARN) 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 or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSubnetIds

public List<String> getSubnetIds()

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.

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.

setSubnetIds

public void setSubnetIds(Collection<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.

Parameters:

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.

withSubnetIds

public CreateClusterRequest withSubnetIds(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.

NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSubnetIds

public CreateClusterRequest withSubnetIds(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTagList

public List<Tag> getTagList()

Tags to apply to the CloudHSM cluster during creation.

Returns:

Tags to apply to the CloudHSM cluster during creation.

setTagList

public void setTagList(Collection<Tag> tagList)

Tags to apply to the CloudHSM cluster during creation.

Parameters:

tagList - Tags to apply to the CloudHSM cluster during creation.

withTagList

public CreateClusterRequest withTagList(Tag... tagList)

Tags to apply to the CloudHSM cluster during creation.

NOTE: This method appends the values to the existing list (if any). Use setTagList(java.util.Collection) or withTagList(java.util.Collection) if you want to override the existing values.

Parameters:

tagList - Tags to apply to the CloudHSM cluster during creation.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTagList

public CreateClusterRequest withTagList(Collection<Tag> tagList)

Tags to apply to the CloudHSM cluster during creation.

Parameters:

tagList - Tags to apply to the CloudHSM cluster during creation.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMode

public void setMode(String mode)

The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

Parameters:

mode - The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

See Also:

ClusterMode

getMode

public String getMode()

The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

Returns:

The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

See Also:

ClusterMode

withMode

public CreateClusterRequest withMode(String mode)

The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

Parameters:

mode - The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ClusterMode

withMode

public CreateClusterRequest withMode(ClusterMode mode)

The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

Parameters:

mode - The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ClusterMode

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateClusterRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()