Skip to content
AWS for Query.Farm

aws.cloudhsm.describe_hsm

Example SQL Queries

SELECT * FROM
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.

Table Definition

Column NameColumn Data Type
hsm_arn Input Column

The ARN of the HSM.

VARCHAR
hsm_serial_number Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
availability_zone

The Availability Zone that the HSM is in.

VARCHAR
eni_id

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

VARCHAR
eni_ip

The IP address assigned to the HSM's ENI.

VARCHAR
hsm_type

The HSM model type.

VARCHAR
iam_role_arn

The ARN of the IAM role assigned to the HSM.

VARCHAR
partitions

The list of partitions on the HSM.

VARCHAR[]
Show child fields
partitions[]
serial_number

The serial number of the HSM.

VARCHAR
server_cert_last_updated

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

VARCHAR
server_cert_uri

The URI of the certificate server.

VARCHAR
software_version

The HSM software version.

VARCHAR
ssh_key_last_updated

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

VARCHAR
ssh_public_key

The public SSH key.

VARCHAR
status

The status of the HSM.

VARCHAR
status_details

Contains additional information about the status of the HSM.

VARCHAR
subnet_id

The identifier of the subnet that the HSM is in.

VARCHAR
subscription_end_date

The subscription end date.

VARCHAR
subscription_start_date

The subscription start date.

VARCHAR
subscription_type

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.

VARCHAR
vendor_name

The name of the HSM vendor.

VARCHAR
vpc_id

The identifier of the VPC that the HSM is in.

VARCHAR