Hsm (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudhsmv2.model.Hsm

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Hsm
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Hsm()

Constructors
Constructor and Description
`Hsm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Hsm`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAvailabilityZone()` The Availability Zone that contains the HSM.
`String`	`getClusterId()` The identifier (ID) of the cluster that contains the HSM.
`String`	`getEniId()` The identifier (ID) of the HSM's elastic network interface (ENI).
`String`	`getEniIp()` The IP address of the HSM's elastic network interface (ENI).
`String`	`getHsmId()` The HSM's identifier (ID).
`String`	`getState()` The HSM's state.
`String`	`getStateMessage()` A description of the HSM's state.
`String`	`getSubnetId()` The subnet that contains the HSM's elastic network interface (ENI).
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAvailabilityZone(String availabilityZone)` The Availability Zone that contains the HSM.
`void`	`setClusterId(String clusterId)` The identifier (ID) of the cluster that contains the HSM.
`void`	`setEniId(String eniId)` The identifier (ID) of the HSM's elastic network interface (ENI).
`void`	`setEniIp(String eniIp)` The IP address of the HSM's elastic network interface (ENI).
`void`	`setHsmId(String hsmId)` The HSM's identifier (ID).
`void`	`setState(String state)` The HSM's state.
`void`	`setStateMessage(String stateMessage)` A description of the HSM's state.
`void`	`setSubnetId(String subnetId)` The subnet that contains the HSM's elastic network interface (ENI).
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Hsm`	`withAvailabilityZone(String availabilityZone)` The Availability Zone that contains the HSM.
`Hsm`	`withClusterId(String clusterId)` The identifier (ID) of the cluster that contains the HSM.
`Hsm`	`withEniId(String eniId)` The identifier (ID) of the HSM's elastic network interface (ENI).
`Hsm`	`withEniIp(String eniIp)` The IP address of the HSM's elastic network interface (ENI).
`Hsm`	`withHsmId(String hsmId)` The HSM's identifier (ID).
`Hsm`	`withState(HsmState state)` The HSM's state.
`Hsm`	`withState(String state)` The HSM's state.
`Hsm`	`withStateMessage(String stateMessage)` A description of the HSM's state.
`Hsm`	`withSubnetId(String subnetId)` The subnet that contains the HSM's elastic network interface (ENI).

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

- Constructor Detail
  - Hsm
```
public Hsm()
```
- Method Detail
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    The Availability Zone that contains the HSM.
    
    Parameters:
    
    availabilityZone - The Availability Zone that contains the HSM.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    The Availability Zone that contains the HSM.
    
    Returns:
    
    The Availability Zone that contains the HSM.
  - withAvailabilityZone
```
public Hsm withAvailabilityZone(String availabilityZone)
```
    The Availability Zone that contains the HSM.
    
    Parameters:
    
    availabilityZone - The Availability Zone that contains the HSM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterId
```
public void setClusterId(String clusterId)
```
    The identifier (ID) of the cluster that contains the HSM.
    
    Parameters:
    
    clusterId - The identifier (ID) of the cluster that contains the HSM.
  - getClusterId
```
public String getClusterId()
```
    The identifier (ID) of the cluster that contains the HSM.
    
    Returns:
    
    The identifier (ID) of the cluster that contains the HSM.
  - withClusterId
```
public Hsm withClusterId(String clusterId)
```
    The identifier (ID) of the cluster that contains the HSM.
    
    Parameters:
    
    clusterId - The identifier (ID) of the cluster that contains the HSM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubnetId
```
public void setSubnetId(String subnetId)
```
    The subnet that contains the HSM's elastic network interface (ENI).
    
    Parameters:
    
    subnetId - The subnet that contains the HSM's elastic network interface (ENI).
  - getSubnetId
```
public String getSubnetId()
```
    The subnet that contains the HSM's elastic network interface (ENI).
    
    Returns:
    
    The subnet that contains the HSM's elastic network interface (ENI).
  - withSubnetId
```
public Hsm withSubnetId(String subnetId)
```
    The subnet that contains the HSM's elastic network interface (ENI).
    
    Parameters:
    
    subnetId - The subnet that contains the HSM's elastic network interface (ENI).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEniId
```
public void setEniId(String eniId)
```
    The identifier (ID) of the HSM's elastic network interface (ENI).
    
    Parameters:
    
    eniId - The identifier (ID) of the HSM's elastic network interface (ENI).
  - getEniId
```
public String getEniId()
```
    The identifier (ID) of the HSM's elastic network interface (ENI).
    
    Returns:
    
    The identifier (ID) of the HSM's elastic network interface (ENI).
  - withEniId
```
public Hsm withEniId(String eniId)
```
    The identifier (ID) of the HSM's elastic network interface (ENI).
    
    Parameters:
    
    eniId - The identifier (ID) of the HSM's elastic network interface (ENI).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEniIp
```
public void setEniIp(String eniIp)
```
    The IP address of the HSM's elastic network interface (ENI).
    
    Parameters:
    
    eniIp - The IP address of the HSM's elastic network interface (ENI).
  - getEniIp
```
public String getEniIp()
```
    The IP address of the HSM's elastic network interface (ENI).
    
    Returns:
    
    The IP address of the HSM's elastic network interface (ENI).
  - withEniIp
```
public Hsm withEniIp(String eniIp)
```
    The IP address of the HSM's elastic network interface (ENI).
    
    Parameters:
    
    eniIp - The IP address of the HSM's elastic network interface (ENI).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHsmId
```
public void setHsmId(String hsmId)
```
    The HSM's identifier (ID).
    
    Parameters:
    
    hsmId - The HSM's identifier (ID).
  - getHsmId
```
public String getHsmId()
```
    The HSM's identifier (ID).
    
    Returns:
    
    The HSM's identifier (ID).
  - withHsmId
```
public Hsm withHsmId(String hsmId)
```
    The HSM's identifier (ID).
    
    Parameters:
    
    hsmId - The HSM's identifier (ID).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The HSM's state.
    
    Parameters:
    
    state - The HSM's state.
    
    See Also:
    
    HsmState
  - getState
```
public String getState()
```
    The HSM's state.
    
    Returns:
    
    The HSM's state.
    
    See Also:
    
    HsmState
  - withState
```
public Hsm withState(String state)
```
    The HSM's state.
    
    Parameters:
    
    state - The HSM's state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HsmState
  - withState
```
public Hsm withState(HsmState state)
```
    The HSM's state.
    
    Parameters:
    
    state - The HSM's state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HsmState
  - setStateMessage
```
public void setStateMessage(String stateMessage)
```
    A description of the HSM's state.
    
    Parameters:
    
    stateMessage - A description of the HSM's state.
  - getStateMessage
```
public String getStateMessage()
```
    A description of the HSM's state.
    
    Returns:
    
    A description of the HSM's state.
  - withStateMessage
```
public Hsm withStateMessage(String stateMessage)
```
    A description of the HSM's state.
    
    Parameters:
    
    stateMessage - A description of the HSM's state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Hsm clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Hsm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Hsm

Method Detail

setAvailabilityZone

getAvailabilityZone

withAvailabilityZone

setClusterId

getClusterId

withClusterId

setSubnetId

getSubnetId

withSubnetId

setEniId

getEniId

withEniId

setEniIp

getEniIp

withEniIp

setHsmId

getHsmId

withHsmId

setState

getState

withState

withState

setStateMessage

getStateMessage

withStateMessage

toString

equals

hashCode

clone

marshall