Class Cluster

java.lang.Object
software.amazon.awssdk.services.cloudhsmv2.model.Cluster
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Cluster.Builder,Cluster>
@Generated("software.amazon.awssdk:codegen") public final class Cluster extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Cluster.Builder,Cluster>

Contains information about an CloudHSM cluster.

See Also:

  • Method Details

    • 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:

    • 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:

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

    • hsmTypeRollbackExpiration

      public final Instant hsmTypeRollbackExpiration()

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

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

    • 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:

    • 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:

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

    • networkType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

      Returns:
      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.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

      Returns:
      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.
      See Also:

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

    • mode

      public final ClusterMode mode()

      The mode of the cluster.

      If the service returns an enum value that is not available in the current SDK version, mode will return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The mode of the cluster.
      See Also:

    • modeAsString

      public final String modeAsString()

      The mode of the cluster.

      If the service returns an enum value that is not available in the current SDK version, mode will return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The mode of the cluster.
      See Also:

    • toBuilder

      public Cluster.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.