CloudHSMV2 / Client / describe_clusters

describe_clusters#

CloudHSMV2.Client.describe_clusters(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_clusters(
    Filters={
        'string': [
            'string',
        ]
    },
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Filters (dict) –

    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.

    • (string) –

      • (list) –

        • (string) –

  • NextToken (string) – The NextToken value that you received in the previous response. Use this value to get more clusters.

  • MaxResults (integer) – The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'Clusters': [
        {
            'BackupPolicy': 'DEFAULT',
            'BackupRetentionPolicy': {
                'Type': 'DAYS',
                'Value': 'string'
            },
            'ClusterId': 'string',
            'CreateTimestamp': datetime(2015, 1, 1),
            'Hsms': [
                {
                    'AvailabilityZone': 'string',
                    'ClusterId': 'string',
                    'SubnetId': 'string',
                    'EniId': 'string',
                    'EniIp': 'string',
                    'EniIpV6': 'string',
                    'HsmId': 'string',
                    'State': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DEGRADED'|'DELETE_IN_PROGRESS'|'DELETED',
                    'StateMessage': 'string'
                },
            ],
            'HsmType': 'string',
            'PreCoPassword': 'string',
            'SecurityGroup': 'string',
            'SourceBackupId': 'string',
            'State': 'CREATE_IN_PROGRESS'|'UNINITIALIZED'|'INITIALIZE_IN_PROGRESS'|'INITIALIZED'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'MODIFY_IN_PROGRESS'|'ROLLBACK_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DEGRADED',
            'StateMessage': 'string',
            'SubnetMapping': {
                'string': 'string'
            },
            'VpcId': 'string',
            'NetworkType': 'IPV4'|'DUALSTACK',
            'Certificates': {
                'ClusterCsr': 'string',
                'HsmCertificate': 'string',
                'AwsHardwareCertificate': 'string',
                'ManufacturerHardwareCertificate': 'string',
                'ClusterCertificate': 'string'
            },
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Mode': 'FIPS'|'NON_FIPS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Clusters (list) –

      A list of clusters.

      • (dict) –

        Contains information about an CloudHSM cluster.

        • BackupPolicy (string) –

          The cluster’s backup policy.

        • BackupRetentionPolicy (dict) –

          A policy that defines how the service retains backups.

          • Type (string) –

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

          • Value (string) –

            Use a value between 7 - 379.

        • ClusterId (string) –

          The cluster’s identifier (ID).

        • CreateTimestamp (datetime) –

          The date and time when the cluster was created.

        • Hsms (list) –

          Contains information about the HSMs in the cluster.

          • (dict) –

            Contains information about a hardware security module (HSM) in an CloudHSM cluster.

            • AvailabilityZone (string) –

              The Availability Zone that contains the HSM.

            • ClusterId (string) –

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

            • SubnetId (string) –

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

            • EniId (string) –

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

            • EniIp (string) –

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

            • EniIpV6 (string) –

              The IPv6 address (if any) of the HSM’s elastic network interface (ENI).

            • HsmId (string) –

              The HSM’s identifier (ID).

            • State (string) –

              The HSM’s state.

            • StateMessage (string) –

              A description of the HSM’s state.

        • HsmType (string) –

          The type of HSM that the cluster contains.

        • PreCoPassword (string) –

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

        • SecurityGroup (string) –

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

        • SourceBackupId (string) –

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

        • State (string) –

          The cluster’s state.

        • StateMessage (string) –

          A description of the cluster’s state.

        • SubnetMapping (dict) –

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

          • (string) –

            • (string) –

        • VpcId (string) –

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

        • NetworkType (string) –

          The cluster’s NetworkType can be set to either IPV4 (which is the default) or DUALSTACK. When set to IPV4, communication between your application and the Hardware Security Modules (HSMs) is restricted to the IPv4 protocol only. In contrast, the DUALSTACK network type enables communication over both the IPv4 and IPv6 protocols. To use the DUALSTACK option, you’ll need to configure your Virtual Private Cloud (VPC) and subnets to support both IPv4 and IPv6. This involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The choice between IPV4 and DUALSTACK network types determines the flexibility of the network addressing setup for your cluster. The DUALSTACK option provides more flexibility by allowing both IPv4 and IPv6 communication.

        • Certificates (dict) –

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

          • ClusterCsr (string) –

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

          • HsmCertificate (string) –

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

          • AwsHardwareCertificate (string) –

            The HSM hardware certificate issued (signed) by CloudHSM.

          • ManufacturerHardwareCertificate (string) –

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

          • ClusterCertificate (string) –

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

        • TagList (list) –

          The list of tags for the cluster.

          • (dict) –

            Contains a tag. A tag is a key-value pair.

            • Key (string) –

              The key of the tag.

            • Value (string) –

              The value of the tag.

        • Mode (string) –

          The mode of the cluster.

    • NextToken (string) –

      An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters request to get more clusters.

Exceptions