Cluster

The cluster's backup policy.

Type: String

Valid Values: DEFAULT

Required: No

A policy that defines how the service retains backups.

Type: BackupRetentionPolicy object

Required: No

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

Type: Certificates object

Required: No

The cluster's identifier (ID).

Type: String

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

Required: No

The date and time when the cluster was created.

Type: Timestamp

Required: No

Contains information about the HSMs in the cluster.

Type: Array of Hsm objects

Required: No

The type of HSM that the cluster contains.

Type: String

Length Constraints: Maximum length of 32.

Pattern: ((p|)hsm[0-9][a-z.]*\.[a-zA-Z]+)

Required: No

The mode of the cluster.

Type: String

Valid Values: FIPS | NON_FIPS

Required: No

The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.

Type: String

Valid Values: IPV4 | DUALSTACK

Required: No

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

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

Type: String

Pattern: sg-[0-9a-fA-F]{8,17}

Required: No

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

The cluster's state.

Type: String

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

Required: No

A description of the cluster's state.

Type: String

Length Constraints: Maximum length of 300.

Pattern: .*

Required: No

A map from availability zone to the cluster’s subnet in that availability zone.

Type: String to string map

Key Pattern: [a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\d[a-z]

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

Required: No

The list of tags for the cluster.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

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

Type: String

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

Required: No