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

Builder

Properties

var backupPolicy: BackupPolicy?

The cluster's backup policy.

backupRetentionPolicy

var backupRetentionPolicy: BackupRetentionPolicy?

A policy that defines how the service retains backups.

var certificates: Certificates?

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

var clusterId: String?

The cluster's identifier (ID).

createTimestamp

var createTimestamp: Instant?

The date and time when the cluster was created.

var hsms: List<Hsm>?

Contains information about the HSMs in the cluster.

var hsmType: String?

The type of HSM that the cluster contains.

hsmTypeRollbackExpiration

var hsmTypeRollbackExpiration: Instant?

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

var mode: ClusterMode?

The mode of the cluster.

var 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.

var preCoPassword: String?

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

var securityGroup: String?

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

var 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.

var state: ClusterState?

The cluster's state.

var stateMessage: String?

A description of the cluster's state.

var subnetMapping: Map<String, String>?

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

var tagList: List<Tag>?

The list of tags for the cluster.

var vpcId: String?

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

Functions

backupRetentionPolicy

fun backupRetentionPolicy(block: BackupRetentionPolicy.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.cloudhsmv2.model.BackupRetentionPolicy inside the given block

fun certificates(block: Certificates.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.cloudhsmv2.model.Certificates inside the given block