Cluster (AWS Java SDK :: Services :: AWS CloudHSM V2 2.20.103 API)

java.lang.Object
- software.amazon.awssdk.services.cloudhsmv2.model.Cluster

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Cluster.Builder,Cluster>

@Generated(value="software.amazon.awssdk:codegen")
public final class Cluster
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Cluster.Builder,Cluster>

Contains information about an AWS CloudHSM cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Cluster.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Cluster.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackupPolicy`	`backupPolicy()` The cluster's backup policy.
`String`	`backupPolicyAsString()` The cluster's backup policy.
`BackupRetentionPolicy`	`backupRetentionPolicy()` A policy that defines how the service retains backups.
`static Cluster.Builder`	`builder()`
`Certificates`	`certificates()` Contains one or more certificates or a certificate signing request (CSR).
`String`	`clusterId()` The cluster's identifier (ID).
`Instant`	`createTimestamp()` The date and time when the cluster was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasHsms()` For responses, this returns true if the service returned a value for the Hsms property.
`boolean`	`hasSubnetMapping()` For responses, this returns true if the service returned a value for the SubnetMapping property.
`boolean`	`hasTagList()` For responses, this returns true if the service returned a value for the TagList property.
`List<Hsm>`	`hsms()` Contains information about the HSMs in the cluster.
`String`	`hsmType()` The type of HSM that the cluster contains.
`String`	`preCoPassword()` The default password for the cluster's Pre-Crypto Officer (PRECO) user.
`List<SdkField<?>>`	`sdkFields()`
`String`	`securityGroup()` The identifier (ID) of the cluster's security group.
`static Class<? extends Cluster.Builder>`	`serializableBuilderClass()`
`String`	`sourceBackupId()` The identifier (ID) of the backup used to create the cluster.
`ClusterState`	`state()` The cluster's state.
`String`	`stateAsString()` The cluster's state.
`String`	`stateMessage()` A description of the cluster's state.
`Map<String,String>`	`subnetMapping()` A map from availability zone to the cluster’s subnet in that availability zone.
`List<Tag>`	`tagList()` The list of tags for the cluster.
`Cluster.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcId()` The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - backupPolicy
```
public final BackupPolicy backupPolicy()
```
    The cluster's backup policy.
    
    If the service returns an enum value that is not available in the current SDK version, backupPolicy will return BackupPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backupPolicyAsString().
    
    Returns:
    
    The cluster's backup policy.
    
    See Also:
    
    BackupPolicy
  - backupPolicyAsString
```
public final String backupPolicyAsString()
```
    The cluster's backup policy.
    
    If the service returns an enum value that is not available in the current SDK version, backupPolicy will return BackupPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backupPolicyAsString().
    
    Returns:
    
    The cluster's backup policy.
    
    See Also:
    
    BackupPolicy
  - backupRetentionPolicy
```
public final BackupRetentionPolicy backupRetentionPolicy()
```
    A policy that defines how the service retains backups.
    
    Returns:
    
    A policy that defines how the service retains backups.
  - clusterId
```
public final String clusterId()
```
    The cluster's identifier (ID).
    
    Returns:
    
    The cluster's identifier (ID).
  - createTimestamp
```
public final Instant createTimestamp()
```
    The date and time when the cluster was created.
    
    Returns:
    
    The date and time when the cluster was created.
  - hasHsms
```
public final boolean hasHsms()
```
    For responses, this returns true if the service returned a value for the Hsms property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - hsms
```
public final List<Hsm> hsms()
```
    Contains information about the HSMs in the cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHsms() method.
    
    Returns:
    
    Contains information about the HSMs in the cluster.
  - hsmType
```
public final String hsmType()
```
    The type of HSM that the cluster contains.
    
    Returns:
    
    The type of HSM that the cluster contains.
  - preCoPassword
```
public final String preCoPassword()
```
    The default password for the cluster's Pre-Crypto Officer (PRECO) user.
    
    Returns:
    
    The default password for the cluster's Pre-Crypto Officer (PRECO) user.
  - securityGroup
```
public final String securityGroup()
```
    The identifier (ID) of the cluster's security group.
    
    Returns:
    
    The identifier (ID) of the cluster's security group.
  - sourceBackupId
```
public final 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.
    
    Returns:
    
    The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
  - state
```
public final ClusterState state()
```
    The cluster's state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ClusterState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The cluster's state.
    
    See Also:
    
    ClusterState
  - stateAsString
```
public final String stateAsString()
```
    The cluster's state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ClusterState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The cluster's state.
    
    See Also:
    
    ClusterState
  - stateMessage
```
public final String stateMessage()
```
    A description of the cluster's state.
    
    Returns:
    
    A description of the cluster's state.
  - hasSubnetMapping
```
public final boolean hasSubnetMapping()
```
    For responses, this returns true if the service returned a value for the SubnetMapping property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - subnetMapping
```
public final Map<String,String> subnetMapping()
```
    A map from availability zone to the cluster’s subnet in that availability zone.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetMapping() method.
    
    Returns:
    
    A map from availability zone to the cluster’s subnet in that availability zone.
  - vpcId
```
public final String vpcId()
```
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    
    Returns:
    
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
  - certificates
```
public final Certificates certificates()
```
    Contains one or more certificates or a certificate signing request (CSR).
    
    Returns:
    
    Contains one or more certificates or a certificate signing request (CSR).
  - hasTagList
```
public final boolean hasTagList()
```
    For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tagList
```
public final List<Tag> tagList()
```
    The list of tags for the cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagList() method.
    
    Returns:
    
    The list of tags for the cluster.
  - toBuilder
```
public Cluster.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
  - builder
```
public static Cluster.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Cluster.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Cluster

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

backupPolicy

backupPolicyAsString

backupRetentionPolicy

clusterId

createTimestamp

hasHsms

hsms

hsmType

preCoPassword

securityGroup

sourceBackupId

state

stateAsString

stateMessage

hasSubnetMapping

subnetMapping

vpcId

certificates

hasTagList

tagList

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields