software.amazon.awssdk.services.cloudhsmv2.model

Class Hsm

java.lang.Object

software.amazon.awssdk.services.cloudhsmv2.model.Hsm

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Hsm.Builder,Hsm>

@Generated(value="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 AWS CloudHSM cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Hsm.Builder

Method Summary

Modifier and Type	Method and Description
String	availabilityZone() The Availability Zone that contains the HSM.
static Hsm.Builder	builder()
String	clusterId() The identifier (ID) of the cluster that contains the HSM.
String	eniId() The identifier (ID) of the HSM's elastic network interface (ENI).
String	eniIp() The IP address of the HSM's elastic network interface (ENI).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hsmId() The HSM's identifier (ID).
List<SdkField<?>>	sdkFields()
static Class<? extends Hsm.Builder>	serializableBuilderClass()
HsmState	state() The HSM's state.
String	stateAsString() The HSM's state.
String	stateMessage() A description of the HSM's state.
String	subnetId() The subnet that contains the HSM's elastic network interface (ENI).
Hsm.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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

hsmId

public final String hsmId()

The HSM's identifier (ID).

Returns:

The HSM's identifier (ID).

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:

HsmState

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:

HsmState

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()

Specified by:

toBuilder in interface ToCopyableBuilder<Hsm.Builder,Hsm>

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)

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