Hsm
Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.
Contents
- HsmId
-
The HSM's identifier (ID).
Type: String
Pattern:
hsm-[2-7a-zA-Z]{11,16}
Required: Yes
- AvailabilityZone
-
The Availability Zone that contains the HSM.
Type: String
Pattern:
[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\d[a-z]
Required: No
- ClusterId
-
The identifier (ID) of the cluster that contains the HSM.
Type: String
Pattern:
cluster-[2-7a-zA-Z]{11,16}
Required: No
- EniId
-
The identifier (ID) of the HSM's elastic network interface (ENI).
Type: String
Pattern:
eni-[0-9a-fA-F]{8,17}
Required: No
- EniIp
-
The IP address of the HSM's elastic network interface (ENI).
Type: String
Pattern:
\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
Required: No
- State
-
The HSM's state.
Type: String
Valid Values:
CREATE_IN_PROGRESS | ACTIVE | DEGRADED | DELETE_IN_PROGRESS | DELETED
Required: No
- StateMessage
-
A description of the HSM's state.
Type: String
Required: No
- SubnetId
-
The subnet that contains the HSM's elastic network interface (ENI).
Type: String
Pattern:
subnet-[0-9a-fA-F]{8,17}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: