Class Hsm

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

Contains information about a hardware security module (HSM) in an CloudHSM cluster.

See Also:

  • Method Details

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone that contains the HSM.

      Returns:
      The Availability Zone that contains the HSM.

    • clusterId

      public final String clusterId()

      The identifier (ID) of the cluster that contains the HSM.

      Returns:
      The identifier (ID) of the cluster that contains the HSM.

    • subnetId

      public final String subnetId()

      The subnet that contains the HSM's elastic network interface (ENI).

      Returns:
      The subnet that contains the HSM's elastic network interface (ENI).

    • eniId

      public final String eniId()

      The identifier (ID) of the HSM's elastic network interface (ENI).

      Returns:
      The identifier (ID) of the HSM's elastic network interface (ENI).

    • eniIp

      public final String eniIp()

      The IP address of the HSM's elastic network interface (ENI).

      Returns:
      The IP address of the HSM's elastic network interface (ENI).

    • eniIpV6

      public final String eniIpV6()

      The IPv6 address (if any) of the HSM's elastic network interface (ENI).

      Returns:
      The IPv6 address (if any) of the HSM's elastic network interface (ENI).

    • hsmId

      public final String hsmId()

      The HSM's identifier (ID).

      Returns:
      The HSM's identifier (ID).

    • hsmType

      public final String hsmType()

      The type of HSM.

      Returns:
      The type of HSM.

    • state

      public final HsmState state()

      The HSM's state.

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

      Returns:
      The HSM's state.
      See Also:

    • stateAsString

      public final String stateAsString()

      The HSM's state.

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

      Returns:
      The HSM's state.
      See Also:

    • stateMessage

      public final String stateMessage()

      A description of the HSM's state.

      Returns:
      A description of the HSM's state.

    • toBuilder

      public Hsm.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<Hsm.Builder,Hsm>
      Returns:
      a builder for type T

    • builder

      public static Hsm.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Hsm.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.