Skip to content

aws.cloudhsmv2.describe_clusters

Example SQL Queries

SELECT * FROM
aws.cloudhsmv2.describe_clusters;

Description

Gets information about CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.

Table Definition

Column NameColumn Data Type
filters Input Column

One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

MAP(VARCHAR, 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
backup_policy

The cluster's backup policy.

VARCHAR
backup_retention_policy

A policy that defines how the service retains backups.

STRUCT(
"type" VARCHAR,
"value" VARCHAR
)
Show child fields
backup_retention_policy.type

The type of backup retention policy. For the DAYS type, the value is the number of days to retain backups.

backup_retention_policy.value

Use a value between 7 - 379.

certificates

Contains one or more certificates or a certificate signing request (CSR).

STRUCT(
"cluster_csr" VARCHAR,
"hsm_certificate" VARCHAR,
"aws_hardware_certificate" VARCHAR,
"manufacturer_hardware_certificate" VARCHAR,
"cluster_certificate" VARCHAR
)
Show child fields
certificates.aws_hardware_certificate

The HSM hardware certificate issued (signed) by CloudHSM.

certificates.cluster_certificate

The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

certificates.cluster_csr

The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.

certificates.hsm_certificate

The HSM certificate issued (signed) by the HSM hardware.

certificates.manufacturer_hardware_certificate

The HSM hardware certificate issued (signed) by the hardware manufacturer.

cluster_id

The cluster's identifier (ID).

VARCHAR
create_timestamp

The date and time when the cluster was created.

TIMESTAMP_S
hsm_type

The type of HSM that the cluster contains.

VARCHAR
hsms

Contains information about the HSMs in the cluster.

STRUCT(
"availability_zone" VARCHAR,
"cluster_id" VARCHAR,
"subnet_id" VARCHAR,
"eni_id" VARCHAR,
"eni_ip" VARCHAR,
"hsm_id" VARCHAR,
"state" VARCHAR,
"state_message" VARCHAR
)[]
Show child fields
hsms[]
Show child fields
hsms[].availability_zone

The Availability Zone that contains the HSM.

hsms[].cluster_id

The identifier (ID) of the cluster that contains the HSM.

hsms[].eni_id

The identifier (ID) of the HSM's elastic network interface (ENI).

hsms[].eni_ip

The IP address of the HSM's elastic network interface (ENI).

hsms[].hsm_id

The HSM's identifier (ID).

hsms[].state

The HSM's state.

hsms[].state_message

A description of the HSM's state.

hsms[].subnet_id

The subnet that contains the HSM's elastic network interface (ENI).

mode

The mode of the cluster.

VARCHAR
pre_co_password

The default password for the cluster's Pre-Crypto Officer (PRECO) user.

VARCHAR
security_group

The identifier (ID) of the cluster's security group.

VARCHAR
source_backup_id

The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

VARCHAR
state

The cluster's state.

VARCHAR
state_message

A description of the cluster's state.

VARCHAR
subnet_mapping

A map from availability zone to the cluster’s subnet in that availability zone.

MAP(VARCHAR, VARCHAR)
tag_list

The list of tags for the cluster.

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tag_list[]
Show child fields
tag_list[].key

The key of the tag.

tag_list[].value

The value of the tag.

vpc_id

The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

VARCHAR