[ aws . cloudhsm ]

describe-hsm

Description

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

For information about the current version of AWS CloudHSM , see AWS CloudHSM , the AWS CloudHSM User Guide , and the AWS CloudHSM API Reference .

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-hsm
[--hsm-arn <value>]
[--hsm-serial-number <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--hsm-arn (string)

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

--hsm-serial-number (string)

The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

HsmArn -> (string)

The ARN of the HSM.

Status -> (string)

The status of the HSM.

StatusDetails -> (string)

Contains additional information about the status of the HSM.

AvailabilityZone -> (string)

The Availability Zone that the HSM is in.

EniId -> (string)

The identifier of the elastic network interface (ENI) attached to the HSM.

EniIp -> (string)

The IP address assigned to the HSM’s ENI.

SubscriptionType -> (string)

Specifies the type of subscription for the HSM.

• PRODUCTION - The HSM is being used in a production environment.

• TRIAL - The HSM is being used in a product trial.

SubscriptionStartDate -> (string)

The subscription start date.

SubscriptionEndDate -> (string)

The subscription end date.

VpcId -> (string)

The identifier of the VPC that the HSM is in.

SubnetId -> (string)

The identifier of the subnet that the HSM is in.

IamRoleArn -> (string)

The ARN of the IAM role assigned to the HSM.

SerialNumber -> (string)

The serial number of the HSM.

VendorName -> (string)

The name of the HSM vendor.

HsmType -> (string)

The HSM model type.

SoftwareVersion -> (string)

The HSM software version.

SshPublicKey -> (string)

The public SSH key.

SshKeyLastUpdated -> (string)

The date and time that the SSH key was last updated.

ServerCertUri -> (string)

The URI of the certificate server.

ServerCertLastUpdated -> (string)

The date and time that the server certificate was last updated.

Partitions -> (list)

The list of partitions on the HSM.

(string)