getCluster

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var cluster = Aws.CloudHsmV2.GetCluster.Invoke(new()
    {
        ClusterId = "cluster-testclusterid",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/cloudhsmv2"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudhsmv2.Cloudhsmv2Functions;
import com.pulumi.aws.cloudhsmv2.inputs.GetClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var cluster = Cloudhsmv2Functions.getCluster(GetClusterArgs.builder()
            .clusterId("cluster-testclusterid")
            .build());

    }
}
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 = aws.cloudhsmv2.getCluster({
    clusterId: "cluster-testclusterid",
});
variables:
  cluster:
    fn::invoke:
      Function: aws:cloudhsmv2:getCluster
      Arguments:
        clusterId: cluster-testclusterid

Using getCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
def get_cluster(cluster_id: Optional[str] = None,
                cluster_state: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                cluster_state: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws:cloudhsmv2/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterId string

ID of Cloud HSM v2 cluster.

ClusterState string

State of the cluster to be found.

ClusterId string

ID of Cloud HSM v2 cluster.

ClusterState string

State of the cluster to be found.

clusterId String

ID of Cloud HSM v2 cluster.

clusterState String

State of the cluster to be found.

clusterId string

ID of Cloud HSM v2 cluster.

clusterState string

State of the cluster to be found.

cluster_id str

ID of Cloud HSM v2 cluster.

cluster_state str

State of the cluster to be found.

clusterId String

ID of Cloud HSM v2 cluster.

clusterState String

State of the cluster to be found.

getCluster Result

The following output properties are available:

ClusterCertificates List<GetClusterClusterCertificate>

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

ID of the security group associated with the CloudHSM cluster.

SubnetIds List<string>

IDs of subnets in which cluster operates.

VpcId string

ID of the VPC that the CloudHSM cluster resides in.

ClusterCertificates []GetClusterClusterCertificate

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

ID of the security group associated with the CloudHSM cluster.

SubnetIds []string

IDs of subnets in which cluster operates.

VpcId string

ID of the VPC that the CloudHSM cluster resides in.

clusterCertificates List<GetClusterClusterCertificate>

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

ID of the security group associated with the CloudHSM cluster.

subnetIds List<String>

IDs of subnets in which cluster operates.

vpcId String

ID of the VPC that the CloudHSM cluster resides in.

clusterCertificates GetClusterClusterCertificate[]

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

ID of the security group associated with the CloudHSM cluster.

subnetIds string[]

IDs of subnets in which cluster operates.

vpcId string

ID of the VPC that the CloudHSM cluster resides in.

cluster_certificates Sequence[GetClusterClusterCertificate]

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

ID of the security group associated with the CloudHSM cluster.

subnet_ids Sequence[str]

IDs of subnets in which cluster operates.

vpc_id str

ID of the VPC that the CloudHSM cluster resides in.

clusterCertificates List<Property Map>

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

ID of the security group associated with the CloudHSM cluster.

subnetIds List<String>

IDs of subnets in which cluster operates.

vpcId String

ID of the VPC that the CloudHSM cluster resides in.

Supporting Types

GetClusterClusterCertificate

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.