Menu
AWS CloudHSM V2
API Reference (API Version 2017-04-28)

Cluster

Contains information about an AWS CloudHSM cluster.

Contents

BackupPolicy

The cluster's backup policy.

Type: String

Valid Values: DEFAULT

Required: No

Certificates

Contains one or more certificates or a certificate signing request (CSR).

Type: Certificates object

Required: No

ClusterId

The cluster's identifier (ID).

Type: String

Pattern: cluster-[2-7a-zA-Z]{11,16}

Required: No

CreateTimestamp

The date and time when the cluster was created.

Type: Timestamp

Required: No

Hsms

Contains information about the HSMs in the cluster.

Type: Array of Hsm objects

Required: No

HsmType

The type of HSM that the cluster contains.

Type: String

Pattern: (hsm1\.medium)

Required: No

PreCoPassword

The default password for the cluster's Pre-Crypto Officer (PRECO) user.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 32.

Required: No

SecurityGroup

The identifier (ID) of the cluster's security group.

Type: String

Pattern: sg-[0-9a-fA-F]

Required: No

SourceBackupId

The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

Type: String

Pattern: backup-[2-7a-zA-Z]{11,16}

Required: No

State

The cluster's state.

Type: String

Valid Values: CREATE_IN_PROGRESS | UNINITIALIZED | INITIALIZE_IN_PROGRESS | INITIALIZED | ACTIVE | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | DELETED | DEGRADED

Required: No

StateMessage

A description of the cluster's state.

Type: String

Length Constraints: Maximum length of 300.

Pattern: .*

Required: No

SubnetMapping

A map of the cluster's subnets and their corresponding Availability Zones.

Type: String to string map

Pattern: subnet-[0-9a-fA-F]{8}

Required: No

VpcId

The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

Type: String

Pattern: vpc-[0-9a-fA-F]

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: