AWS v6.77.0, Apr 9 25

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.cloudhsmv2.getCluster

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

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

import pulumi
import pulumi_aws as aws

cluster = aws.cloudhsmv2.get_cluster(cluster_id="cluster-testclusterid")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}

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

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

});

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());

    }
}

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.

TypeScript
Python
Go
C#
Java
YAML

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)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

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.
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.
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.
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.
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_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.
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

AwsHardwareCertificate string: The HSM hardware certificate issued (signed) by AWS CloudHSM.
ClusterCertificate string: The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
ClusterCsr string: The certificate signing request (CSR). Available only in UNINITIALIZED state.
HsmCertificate string: The HSM certificate issued (signed) by the HSM hardware.
ManufacturerHardwareCertificate string: The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

AwsHardwareCertificate string: The HSM hardware certificate issued (signed) by AWS CloudHSM.
ClusterCertificate string: The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
ClusterCsr string: The certificate signing request (CSR). Available only in UNINITIALIZED state.
HsmCertificate string: The HSM certificate issued (signed) by the HSM hardware.
ManufacturerHardwareCertificate string: The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

awsHardwareCertificate String: The HSM hardware certificate issued (signed) by AWS CloudHSM.
clusterCertificate String: The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
clusterCsr String: The certificate signing request (CSR). Available only in UNINITIALIZED state.
hsmCertificate String: The HSM certificate issued (signed) by the HSM hardware.
manufacturerHardwareCertificate String: The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

awsHardwareCertificate string: The HSM hardware certificate issued (signed) by AWS CloudHSM.
clusterCertificate string: The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
clusterCsr string: The certificate signing request (CSR). Available only in UNINITIALIZED state.
hsmCertificate string: The HSM certificate issued (signed) by the HSM hardware.
manufacturerHardwareCertificate string: The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

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

awsHardwareCertificate String: The HSM hardware certificate issued (signed) by AWS CloudHSM.
clusterCertificate String: The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
clusterCsr String: The certificate signing request (CSR). Available only in UNINITIALIZED state.
hsmCertificate String: The HSM certificate issued (signed) by the HSM hardware.
manufacturerHardwareCertificate String: The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

Package Details

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

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-aws

aws.cloudhsmv2.getCluster

On this page

On this page

Example Usage

Using getCluster

getCluster Result

Supporting Types

GetClusterClusterCertificate

Package Details

On this page

On this page