/AWS1/CL_HSMDESCRHSMRESPONSE¶
Contains the output of the DescribeHsm operation.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_hsmarn TYPE /AWS1/HSMHSMARN /AWS1/HSMHSMARN¶
The ARN of the HSM.
iv_status TYPE /AWS1/HSMHSMSTATUS /AWS1/HSMHSMSTATUS¶
The status of the HSM.
iv_statusdetails TYPE /AWS1/HSMSTRING /AWS1/HSMSTRING¶
Contains additional information about the status of the HSM.
iv_availabilityzone TYPE /AWS1/HSMAZ /AWS1/HSMAZ¶
The Availability Zone that the HSM is in.
iv_eniid TYPE /AWS1/HSMENIID /AWS1/HSMENIID¶
The identifier of the elastic network interface (ENI) attached to the HSM.
iv_eniip TYPE /AWS1/HSMIPADDRESS /AWS1/HSMIPADDRESS¶
The IP address assigned to the HSM's ENI.
iv_subscriptiontype TYPE /AWS1/HSMSUBSCRIPTIONTYPE /AWS1/HSMSUBSCRIPTIONTYPE¶
SubscriptionType
iv_subscriptionstartdate TYPE /AWS1/HSMTIMESTAMP /AWS1/HSMTIMESTAMP¶
The subscription start date.
iv_subscriptionenddate TYPE /AWS1/HSMTIMESTAMP /AWS1/HSMTIMESTAMP¶
The subscription end date.
iv_vpcid TYPE /AWS1/HSMVPCID /AWS1/HSMVPCID¶
The identifier of the VPC that the HSM is in.
iv_subnetid TYPE /AWS1/HSMSUBNETID /AWS1/HSMSUBNETID¶
The identifier of the subnet that the HSM is in.
iv_iamrolearn TYPE /AWS1/HSMIAMROLEARN /AWS1/HSMIAMROLEARN¶
The ARN of the IAM role assigned to the HSM.
iv_serialnumber TYPE /AWS1/HSMHSMSERIALNUMBER /AWS1/HSMHSMSERIALNUMBER¶
The serial number of the HSM.
iv_vendorname TYPE /AWS1/HSMSTRING /AWS1/HSMSTRING¶
The name of the HSM vendor.
iv_hsmtype TYPE /AWS1/HSMSTRING /AWS1/HSMSTRING¶
The HSM model type.
iv_softwareversion TYPE /AWS1/HSMSTRING /AWS1/HSMSTRING¶
The HSM software version.
iv_sshpublickey TYPE /AWS1/HSMSSHKEY /AWS1/HSMSSHKEY¶
The public SSH key.
iv_sshkeylastupdated TYPE /AWS1/HSMTIMESTAMP /AWS1/HSMTIMESTAMP¶
The date and time that the SSH key was last updated.
iv_servercerturi TYPE /AWS1/HSMSTRING /AWS1/HSMSTRING¶
The URI of the certificate server.
iv_servercertlastupdated TYPE /AWS1/HSMTIMESTAMP /AWS1/HSMTIMESTAMP¶
The date and time that the server certificate was last updated.
it_partitions TYPE /AWS1/CL_HSMPARTITIONLIST_W=>TT_PARTITIONLIST TT_PARTITIONLIST¶
The list of partitions on the HSM.
Queryable Attributes¶
HsmArn¶
The ARN of the HSM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HSMARN() |
Getter for HSMARN, with configurable default |
ASK_HSMARN() |
Getter for HSMARN w/ exceptions if field has no value |
HAS_HSMARN() |
Determine if HSMARN has a value |
Status¶
The status of the HSM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
StatusDetails¶
Contains additional information about the status of the HSM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSDETAILS() |
Getter for STATUSDETAILS, with configurable default |
ASK_STATUSDETAILS() |
Getter for STATUSDETAILS w/ exceptions if field has no value |
HAS_STATUSDETAILS() |
Determine if STATUSDETAILS has a value |
AvailabilityZone¶
The Availability Zone that the HSM is in.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE, with configurable default |
ASK_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE w/ exceptions if field has no va |
HAS_AVAILABILITYZONE() |
Determine if AVAILABILITYZONE has a value |
EniId¶
The identifier of the elastic network interface (ENI) attached to the HSM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENIID() |
Getter for ENIID, with configurable default |
ASK_ENIID() |
Getter for ENIID w/ exceptions if field has no value |
HAS_ENIID() |
Determine if ENIID has a value |
EniIp¶
The IP address assigned to the HSM's ENI.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENIIP() |
Getter for ENIIP, with configurable default |
ASK_ENIIP() |
Getter for ENIIP w/ exceptions if field has no value |
HAS_ENIIP() |
Determine if ENIIP has a value |
SubscriptionType¶
SubscriptionType
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBSCRIPTIONTYPE() |
Getter for SUBSCRIPTIONTYPE, with configurable default |
ASK_SUBSCRIPTIONTYPE() |
Getter for SUBSCRIPTIONTYPE w/ exceptions if field has no va |
HAS_SUBSCRIPTIONTYPE() |
Determine if SUBSCRIPTIONTYPE has a value |
SubscriptionStartDate¶
The subscription start date.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBSCRIPTIONSTARTDATE() |
Getter for SUBSCRIPTIONSTARTDATE, with configurable default |
ASK_SUBSCRIPTIONSTARTDATE() |
Getter for SUBSCRIPTIONSTARTDATE w/ exceptions if field has |
HAS_SUBSCRIPTIONSTARTDATE() |
Determine if SUBSCRIPTIONSTARTDATE has a value |
SubscriptionEndDate¶
The subscription end date.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBSCRIPTIONENDDATE() |
Getter for SUBSCRIPTIONENDDATE, with configurable default |
ASK_SUBSCRIPTIONENDDATE() |
Getter for SUBSCRIPTIONENDDATE w/ exceptions if field has no |
HAS_SUBSCRIPTIONENDDATE() |
Determine if SUBSCRIPTIONENDDATE has a value |
VpcId¶
The identifier of the VPC that the HSM is in.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCID() |
Getter for VPCID, with configurable default |
ASK_VPCID() |
Getter for VPCID w/ exceptions if field has no value |
HAS_VPCID() |
Determine if VPCID has a value |
SubnetId¶
The identifier of the subnet that the HSM is in.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBNETID() |
Getter for SUBNETID, with configurable default |
ASK_SUBNETID() |
Getter for SUBNETID w/ exceptions if field has no value |
HAS_SUBNETID() |
Determine if SUBNETID has a value |
IamRoleArn¶
The ARN of the IAM role assigned to the HSM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IAMROLEARN() |
Getter for IAMROLEARN, with configurable default |
ASK_IAMROLEARN() |
Getter for IAMROLEARN w/ exceptions if field has no value |
HAS_IAMROLEARN() |
Determine if IAMROLEARN has a value |
SerialNumber¶
The serial number of the HSM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERIALNUMBER() |
Getter for SERIALNUMBER, with configurable default |
ASK_SERIALNUMBER() |
Getter for SERIALNUMBER w/ exceptions if field has no value |
HAS_SERIALNUMBER() |
Determine if SERIALNUMBER has a value |
VendorName¶
The name of the HSM vendor.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VENDORNAME() |
Getter for VENDORNAME, with configurable default |
ASK_VENDORNAME() |
Getter for VENDORNAME w/ exceptions if field has no value |
HAS_VENDORNAME() |
Determine if VENDORNAME has a value |
HsmType¶
The HSM model type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HSMTYPE() |
Getter for HSMTYPE, with configurable default |
ASK_HSMTYPE() |
Getter for HSMTYPE w/ exceptions if field has no value |
HAS_HSMTYPE() |
Determine if HSMTYPE has a value |
SoftwareVersion¶
The HSM software version.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOFTWAREVERSION() |
Getter for SOFTWAREVERSION, with configurable default |
ASK_SOFTWAREVERSION() |
Getter for SOFTWAREVERSION w/ exceptions if field has no val |
HAS_SOFTWAREVERSION() |
Determine if SOFTWAREVERSION has a value |
SshPublicKey¶
The public SSH key.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SSHPUBLICKEY() |
Getter for SSHPUBLICKEY, with configurable default |
ASK_SSHPUBLICKEY() |
Getter for SSHPUBLICKEY w/ exceptions if field has no value |
HAS_SSHPUBLICKEY() |
Determine if SSHPUBLICKEY has a value |
SshKeyLastUpdated¶
The date and time that the SSH key was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SSHKEYLASTUPDATED() |
Getter for SSHKEYLASTUPDATED, with configurable default |
ASK_SSHKEYLASTUPDATED() |
Getter for SSHKEYLASTUPDATED w/ exceptions if field has no v |
HAS_SSHKEYLASTUPDATED() |
Determine if SSHKEYLASTUPDATED has a value |
ServerCertUri¶
The URI of the certificate server.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVERCERTURI() |
Getter for SERVERCERTURI, with configurable default |
ASK_SERVERCERTURI() |
Getter for SERVERCERTURI w/ exceptions if field has no value |
HAS_SERVERCERTURI() |
Determine if SERVERCERTURI has a value |
ServerCertLastUpdated¶
The date and time that the server certificate was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVERCERTLASTUPDATED() |
Getter for SERVERCERTLASTUPDATED, with configurable default |
ASK_SERVERCERTLASTUPDATED() |
Getter for SERVERCERTLASTUPDATED w/ exceptions if field has |
HAS_SERVERCERTLASTUPDATED() |
Determine if SERVERCERTLASTUPDATED has a value |
Partitions¶
The list of partitions on the HSM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARTITIONS() |
Getter for PARTITIONS, with configurable default |
ASK_PARTITIONS() |
Getter for PARTITIONS w/ exceptions if field has no value |
HAS_PARTITIONS() |
Determine if PARTITIONS has a value |