software.amazon.awssdk.services.cloudhsmv2.model

Interface Cluster.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Cluster.Builder,Cluster>, SdkBuilder<Cluster.Builder,Cluster>, SdkPojo

Enclosing class:

Cluster

public static interface Cluster.Builder
extends SdkPojo, CopyableBuilder<Cluster.Builder,Cluster>

Method Summary

Modifier and Type	Method and Description
Cluster.Builder	backupPolicy(BackupPolicy backupPolicy) The cluster's backup policy.
Cluster.Builder	backupPolicy(String backupPolicy) The cluster's backup policy.
Cluster.Builder	backupRetentionPolicy(BackupRetentionPolicy backupRetentionPolicy) A policy that defines how the service retains backups.
default Cluster.Builder	backupRetentionPolicy(Consumer<BackupRetentionPolicy.Builder> backupRetentionPolicy) A policy that defines how the service retains backups.
Cluster.Builder	certificates(Certificates certificates) Contains one or more certificates or a certificate signing request (CSR).
default Cluster.Builder	certificates(Consumer<Certificates.Builder> certificates) Contains one or more certificates or a certificate signing request (CSR).
Cluster.Builder	clusterId(String clusterId) The cluster's identifier (ID).
Cluster.Builder	createTimestamp(Instant createTimestamp) The date and time when the cluster was created.
Cluster.Builder	hsms(Collection<Hsm> hsms) Contains information about the HSMs in the cluster.
Cluster.Builder	hsms(Consumer<Hsm.Builder>... hsms) Contains information about the HSMs in the cluster.
Cluster.Builder	hsms(Hsm... hsms) Contains information about the HSMs in the cluster.
Cluster.Builder	hsmType(String hsmType) The type of HSM that the cluster contains.
Cluster.Builder	preCoPassword(String preCoPassword) The default password for the cluster's Pre-Crypto Officer (PRECO) user.
Cluster.Builder	securityGroup(String securityGroup) The identifier (ID) of the cluster's security group.
Cluster.Builder	sourceBackupId(String sourceBackupId) The identifier (ID) of the backup used to create the cluster.
Cluster.Builder	state(ClusterState state) The cluster's state.
Cluster.Builder	state(String state) The cluster's state.
Cluster.Builder	stateMessage(String stateMessage) A description of the cluster's state.
Cluster.Builder	subnetMapping(Map<String,String> subnetMapping) A map from availability zone to the cluster’s subnet in that availability zone.
Cluster.Builder	tagList(Collection<Tag> tagList) The list of tags for the cluster.
Cluster.Builder	tagList(Consumer<Tag.Builder>... tagList) The list of tags for the cluster.
Cluster.Builder	tagList(Tag... tagList) The list of tags for the cluster.
Cluster.Builder	vpcId(String vpcId) The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

backupPolicy

Cluster.Builder backupPolicy(String backupPolicy)

The cluster's backup policy.

Parameters:

backupPolicy - The cluster's backup policy.

Returns:

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

See Also:

BackupPolicy, BackupPolicy

backupPolicy

Cluster.Builder backupPolicy(BackupPolicy backupPolicy)

The cluster's backup policy.

Parameters:

backupPolicy - The cluster's backup policy.

Returns:

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

See Also:

BackupPolicy, BackupPolicy

backupRetentionPolicy

Cluster.Builder backupRetentionPolicy(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.

backupRetentionPolicy

default Cluster.Builder backupRetentionPolicy(Consumer<BackupRetentionPolicy.Builder> backupRetentionPolicy)

A policy that defines how the service retains backups.

This is a convenience method that creates an instance of the BackupRetentionPolicy.Builder avoiding the need to create one manually via BackupRetentionPolicy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to backupRetentionPolicy(BackupRetentionPolicy).

Parameters:

backupRetentionPolicy - a consumer that will call methods on BackupRetentionPolicy.Builder

Returns:

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

See Also:

backupRetentionPolicy(BackupRetentionPolicy)

clusterId

Cluster.Builder clusterId(String clusterId)

The cluster's identifier (ID).

Parameters:

clusterId - The cluster's identifier (ID).

Returns:

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

createTimestamp

Cluster.Builder createTimestamp(Instant createTimestamp)

The date and time when the cluster was created.

Parameters:

createTimestamp - The date and time when the cluster was created.

Returns:

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

hsms

Cluster.Builder hsms(Collection<Hsm> hsms)

Contains information about the HSMs in the cluster.

Parameters:

hsms - Contains information about the HSMs in the cluster.

Returns:

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

hsms

Cluster.Builder hsms(Hsm... hsms)

Contains information about the HSMs in the cluster.

Parameters:

hsms - Contains information about the HSMs in the cluster.

Returns:

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

hsms

Cluster.Builder hsms(Consumer<Hsm.Builder>... hsms)

Contains information about the HSMs in the cluster.

This is a convenience method that creates an instance of the Hsm.Builder avoiding the need to create one manually via Hsm.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #hsms(List).

Parameters:

hsms - a consumer that will call methods on Hsm.Builder

Returns:

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

See Also:

#hsms(java.util.Collection)

hsmType

Cluster.Builder hsmType(String hsmType)

The type of HSM that the cluster contains.

Parameters:

hsmType - The type of HSM that the cluster contains.

Returns:

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

preCoPassword

Cluster.Builder preCoPassword(String preCoPassword)

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

Parameters:

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

Returns:

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

securityGroup

Cluster.Builder securityGroup(String securityGroup)

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

Parameters:

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

Returns:

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

sourceBackupId

Cluster.Builder sourceBackupId(String sourceBackupId)

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

Parameters:

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

Returns:

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

state

Cluster.Builder state(String state)

The cluster's state.

Parameters:

state - The cluster's state.

Returns:

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

See Also:

ClusterState, ClusterState

state

Cluster.Builder state(ClusterState state)

The cluster's state.

Parameters:

state - The cluster's state.

Returns:

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

See Also:

ClusterState, ClusterState

stateMessage

Cluster.Builder stateMessage(String stateMessage)

A description of the cluster's state.

Parameters:

stateMessage - A description of the cluster's state.

Returns:

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

subnetMapping

Cluster.Builder subnetMapping(Map<String,String> subnetMapping)

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

Parameters:

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

Returns:

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

vpcId

Cluster.Builder vpcId(String vpcId)

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

Parameters:

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

Returns:

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

certificates

Cluster.Builder certificates(Certificates certificates)

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

Parameters:

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

Returns:

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

certificates

default Cluster.Builder certificates(Consumer<Certificates.Builder> certificates)

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

This is a convenience method that creates an instance of the Certificates.Builder avoiding the need to create one manually via Certificates.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to certificates(Certificates).

Parameters:

certificates - a consumer that will call methods on Certificates.Builder

Returns:

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

See Also:

certificates(Certificates)

tagList

Cluster.Builder tagList(Collection<Tag> tagList)

The list of tags for the cluster.

Parameters:

tagList - The list of tags for the cluster.

Returns:

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

tagList

Cluster.Builder tagList(Tag... tagList)

The list of tags for the cluster.

Parameters:

tagList - The list of tags for the cluster.

Returns:

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

tagList

Cluster.Builder tagList(Consumer<Tag.Builder>... tagList)

The list of tags for the cluster.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tagList(List).

Parameters:

tagList - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tagList(java.util.Collection)