Interface Cluster.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Cluster.Builder,
,Cluster> SdkBuilder<Cluster.Builder,
,Cluster> SdkPojo
- Enclosing class:
Cluster
-
Method Summary
Modifier and TypeMethodDescriptionbackupPolicy
(String backupPolicy) The cluster's backup policy.backupPolicy
(BackupPolicy backupPolicy) The cluster's backup policy.default Cluster.Builder
backupRetentionPolicy
(Consumer<BackupRetentionPolicy.Builder> backupRetentionPolicy) A policy that defines how the service retains backups.backupRetentionPolicy
(BackupRetentionPolicy backupRetentionPolicy) A policy that defines how the service retains backups.default Cluster.Builder
certificates
(Consumer<Certificates.Builder> certificates) Contains one or more certificates or a certificate signing request (CSR).certificates
(Certificates certificates) Contains one or more certificates or a certificate signing request (CSR).The cluster's identifier (ID).createTimestamp
(Instant createTimestamp) The date and time when the cluster was created.hsms
(Collection<Hsm> hsms) Contains information about the HSMs in the cluster.hsms
(Consumer<Hsm.Builder>... hsms) Contains information about the HSMs in the cluster.Contains information about the HSMs in the cluster.The type of HSM that the cluster contains.preCoPassword
(String preCoPassword) The default password for the cluster's Pre-Crypto Officer (PRECO) user.securityGroup
(String securityGroup) The identifier (ID) of the cluster's security group.sourceBackupId
(String sourceBackupId) The identifier (ID) of the backup used to create the cluster.The cluster's state.state
(ClusterState state) The cluster's state.stateMessage
(String stateMessage) A description of the cluster's state.subnetMapping
(Map<String, String> subnetMapping) A map from availability zone to the cluster’s subnet in that availability zone.tagList
(Collection<Tag> tagList) The list of tags for the cluster.tagList
(Consumer<Tag.Builder>... tagList) The list of tags for the cluster.The list of tags for the cluster.The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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:
-
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 theBackupRetentionPolicy.Builder
avoiding the need to create one manually viaBackupRetentionPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobackupRetentionPolicy(BackupRetentionPolicy)
.- Parameters:
backupRetentionPolicy
- a consumer that will call methods onBackupRetentionPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
Contains information about the HSMs in the cluster.
This is a convenience method that creates an instance of theHsm.Builder
avoiding the need to create one manually viaHsm.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohsms(List<Hsm>)
.- Parameters:
hsms
- a consumer that will call methods onHsm.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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:
-
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:
-
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
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
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
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
Contains one or more certificates or a certificate signing request (CSR).
This is a convenience method that creates an instance of theCertificates.Builder
avoiding the need to create one manually viaCertificates.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocertificates(Certificates)
.- Parameters:
certificates
- a consumer that will call methods onCertificates.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
The list of tags for the cluster.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totagList(List<Tag>)
.- Parameters:
tagList
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-