1. Docs
  2. Reference
  3. API
  4. AWS
  5. cloudhsmv2
  6. GetCluster

GetCluster

Use this data source to get information about a CloudHSM v2 cluster

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var cluster = Output.Create(Aws.CloudHsmV2.GetCluster.InvokeAsync(new Aws.CloudHsmV2.GetClusterArgs
        {
            ClusterId = "cluster-testclusterid",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/cloudhsmv2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := cloudhsmv2.LookupCluster(ctx, &cloudhsmv2.LookupClusterArgs{
            ClusterId: "cluster-testclusterid",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

cluster = aws.cloudhsmv2.get_cluster(cluster_id="cluster-testclusterid")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const cluster = pulumi.output(aws.cloudhsmv2.getCluster({
    clusterId: "cluster-testclusterid",
}, { async: true }));

Using GetCluster

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function  get_cluster(cluster_id=None, cluster_state=None, opts=None)
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)

Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster {
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterId string

The id of Cloud HSM v2 cluster.

ClusterState string

The state of the cluster to be found.

ClusterId string

The id of Cloud HSM v2 cluster.

ClusterState string

The state of the cluster to be found.

clusterId string

The id of Cloud HSM v2 cluster.

clusterState string

The state of the cluster to be found.

cluster_id str

The id of Cloud HSM v2 cluster.

cluster_state str

The state of the cluster to be found.

GetCluster Result

The following output properties are available:

ClusterCertificates GetClusterClusterCertificates

The list of cluster certificates. * cluster_certificates.0.cluster_certificate - The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster’s owner. * cluster_certificates.0.cluster_csr - The certificate signing request (CSR). Available only in UNINITIALIZED state. * cluster_certificates.0.aws_hardware_certificate - The HSM hardware certificate issued (signed) by AWS CloudHSM. * cluster_certificates.0.hsm_certificate - The HSM certificate issued (signed) by the HSM hardware. * cluster_certificates.0.manufacturer_hardware_certificate - The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

ClusterId string
ClusterState string
Id string

The provider-assigned unique ID for this managed resource.

SecurityGroupId string

The ID of the security group associated with the CloudHSM cluster.

SubnetIds List<string>

The IDs of subnets in which cluster operates.

VpcId string

The id of the VPC that the CloudHSM cluster resides in.

ClusterCertificates GetClusterClusterCertificates

The list of cluster certificates. * cluster_certificates.0.cluster_certificate - The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster’s owner. * cluster_certificates.0.cluster_csr - The certificate signing request (CSR). Available only in UNINITIALIZED state. * cluster_certificates.0.aws_hardware_certificate - The HSM hardware certificate issued (signed) by AWS CloudHSM. * cluster_certificates.0.hsm_certificate - The HSM certificate issued (signed) by the HSM hardware. * cluster_certificates.0.manufacturer_hardware_certificate - The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

ClusterId string
ClusterState string
Id string

The provider-assigned unique ID for this managed resource.

SecurityGroupId string

The ID of the security group associated with the CloudHSM cluster.

SubnetIds []string

The IDs of subnets in which cluster operates.

VpcId string

The id of the VPC that the CloudHSM cluster resides in.

clusterCertificates GetClusterClusterCertificates

The list of cluster certificates. * cluster_certificates.0.cluster_certificate - The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster’s owner. * cluster_certificates.0.cluster_csr - The certificate signing request (CSR). Available only in UNINITIALIZED state. * cluster_certificates.0.aws_hardware_certificate - The HSM hardware certificate issued (signed) by AWS CloudHSM. * cluster_certificates.0.hsm_certificate - The HSM certificate issued (signed) by the HSM hardware. * cluster_certificates.0.manufacturer_hardware_certificate - The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

clusterId string
clusterState string
id string

The provider-assigned unique ID for this managed resource.

securityGroupId string

The ID of the security group associated with the CloudHSM cluster.

subnetIds string[]

The IDs of subnets in which cluster operates.

vpcId string

The id of the VPC that the CloudHSM cluster resides in.

cluster_certificates Dict[GetClusterClusterCertificates]

The list of cluster certificates. * cluster_certificates.0.cluster_certificate - The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster’s owner. * cluster_certificates.0.cluster_csr - The certificate signing request (CSR). Available only in UNINITIALIZED state. * cluster_certificates.0.aws_hardware_certificate - The HSM hardware certificate issued (signed) by AWS CloudHSM. * cluster_certificates.0.hsm_certificate - The HSM certificate issued (signed) by the HSM hardware. * cluster_certificates.0.manufacturer_hardware_certificate - The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

cluster_id str
cluster_state str
id str

The provider-assigned unique ID for this managed resource.

security_group_id str

The ID of the security group associated with the CloudHSM cluster.

subnet_ids List[str]

The IDs of subnets in which cluster operates.

vpc_id str

The id of the VPC that the CloudHSM cluster resides in.

Supporting Types

GetClusterClusterCertificates

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

AwsHardwareCertificate string
ClusterCertificate string
ClusterCsr string
HsmCertificate string
ManufacturerHardwareCertificate string
AwsHardwareCertificate string
ClusterCertificate string
ClusterCsr string
HsmCertificate string
ManufacturerHardwareCertificate string
awsHardwareCertificate string
clusterCertificate string
clusterCsr string
hsmCertificate string
manufacturerHardwareCertificate string
awsHardwareCertificate str
clusterCertificate str
clusterCsr str
hsmCertificate str
manufacturerHardwareCertificate str

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.