cloudhsmv2/aws.sdk.kotlin.services.cloudhsmv2.model/Cluster

Cluster

Contains information about an CloudHSM cluster.

Types

object Companion

Properties

val backupPolicy: BackupPolicy?

The cluster's backup policy.

backupRetentionPolicy

val backupRetentionPolicy: BackupRetentionPolicy?

A policy that defines how the service retains backups.

val certificates: Certificates?

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

val clusterId: String?

The cluster's identifier (ID).

createTimestamp

val createTimestamp: Instant?

The date and time when the cluster was created.

val hsms: List<Hsm>?

Contains information about the HSMs in the cluster.

val hsmType: String?

The type of HSM that the cluster contains.

hsmTypeRollbackExpiration

val hsmTypeRollbackExpiration: Instant?

The timestamp until when the cluster can be rolled back to its original HSM type.

val mode: ClusterMode?

The mode of the cluster.

val networkType: NetworkType?

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.

val preCoPassword: String?

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

val securityGroup: String?

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

val sourceBackupId: String?

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

val state: ClusterState?

The cluster's state.

val stateMessage: String?

A description of the cluster's state.

val subnetMapping: Map<String, String>?

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

val tagList: List<Tag>?

The list of tags for the cluster.

val vpcId: String?

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

Functions

inline fun copy(block: Cluster.Builder.() -> Unit = {}): Cluster

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String