Cluster

Creates an Amazon CloudHSM v2 cluster.

For information about CloudHSM v2, see the AWS CloudHSM User Guide and the [Amazon CloudHSM API Reference][2].

NOTE: CloudHSM can take up to several minutes to be set up. Practically no single attribute can be updated except TAGS. If you need to delete a cluster, you have to remove its HSM modules first. To initialize cluster, you have to add an hsm instance to the cluster then sign CSR and upload it.

Example Usage

Coming soon!

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

const available = pulumi.output(aws.getAvailabilityZones({ async: true }));
const cloudhsmV2Vpc = new aws.ec2.Vpc("cloudhsm_v2_vpc", {
    cidrBlock: "10.0.0.0/16",
    tags: {
        Name: "example-aws_cloudhsm_v2_cluster",
    },
});
const cloudhsmV2Subnets: aws.ec2.Subnet[] = [];
for (let i = 0; i < 2; i++) {
    cloudhsmV2Subnets.push(new aws.ec2.Subnet(`cloudhsm_v2_subnets-${i}`, {
        availabilityZone: available.apply(available => available.names[i]),
        cidrBlock: var_subnets[i],
        mapPublicIpOnLaunch: false,
        tags: {
            Name: "example-aws_cloudhsm_v2_cluster",
        },
        vpcId: cloudhsmV2Vpc.id,
    }));
}
const cloudhsmV2Cluster = new aws.cloudhsmv2.Cluster("cloudhsm_v2_cluster", {
    hsmType: "hsm1.medium",
    subnetIds: cloudhsmV2Subnets.map(v => v.id),
    tags: {
        Name: "example-aws_cloudhsm_v2_cluster",
    },
});

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

def Cluster(resource_name, opts=None, hsm_type=None, source_backup_identifier=None, subnet_ids=None, tags=None, __props__=None);

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Cluster resource accepts the following input properties:

HsmType string: The type of HSM module in the cluster. Currently, only hsm1.medium is supported.
SubnetIds List<string>: The IDs of subnets in which cluster will operate.
SourceBackupIdentifier string: The id of Cloud HSM v2 cluster backup to be restored.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

HsmType string: The type of HSM module in the cluster. Currently, only hsm1.medium is supported.
SubnetIds []string: The IDs of subnets in which cluster will operate.
SourceBackupIdentifier string: The id of Cloud HSM v2 cluster backup to be restored.
Tags map[string]string: A map of tags to assign to the resource.

hsmType string: The type of HSM module in the cluster. Currently, only hsm1.medium is supported.
subnetIds string[]: The IDs of subnets in which cluster will operate.
sourceBackupIdentifier string: The id of Cloud HSM v2 cluster backup to be restored.
tags {[key: string]: string}: A map of tags to assign to the resource.

hsm_type str: The type of HSM module in the cluster. Currently, only hsm1.medium is supported.
subnet_ids List[str]: The IDs of subnets in which cluster will operate.
source_backup_identifier str: The id of Cloud HSM v2 cluster backup to be restored.
tags Dict[str, str]: A map of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

ClusterCertificates List<ClusterClusterCertificate>: 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 after an hsm instance is added to the cluster. * 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.
ClusterId string: The id of the CloudHSM cluster.
Id string: The provider-assigned unique ID for this managed resource.
SecurityGroupId string: The ID of the security group associated with the CloudHSM cluster.
State string: The state of the cluster.
VpcId string: The id of the VPC that the CloudHSM cluster resides in.

ClusterCertificates []ClusterClusterCertificate: 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 after an hsm instance is added to the cluster. * 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.
ClusterId string: The id of the CloudHSM cluster.
ClusterState string: The state of the cluster.
Id string: The provider-assigned unique ID for this managed resource.
SecurityGroupId string: The ID of the security group associated with the CloudHSM cluster.
VpcId string: The id of the VPC that the CloudHSM cluster resides in.

clusterCertificates ClusterClusterCertificate[]: 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 after an hsm instance is added to the cluster. * 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.
clusterId string: The id of the CloudHSM cluster.
clusterState string: The state of the cluster.
id string: The provider-assigned unique ID for this managed resource.
securityGroupId string: The ID of the security group associated with the CloudHSM cluster.
vpcId string: The id of the VPC that the CloudHSM cluster resides in.

cluster_certificates List[ClusterClusterCertificate]: 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 after an hsm instance is added to the cluster. * 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.
cluster_id str: The id of the CloudHSM cluster.
cluster_state str: The state of the cluster.
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.
vpc_id str: The id of the VPC that the CloudHSM cluster resides in.

Look up an Existing Cluster Resource

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster

static get(resource_name, id, opts=None, cluster_certificates=None, cluster_id=None, cluster_state=None, hsm_type=None, security_group_id=None, source_backup_identifier=None, subnet_ids=None, tags=None, vpc_id=None, __props__=None);

func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)

public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ClusterCertificates List<ClusterClusterCertificateArgs>: 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 after an hsm instance is added to the cluster. * 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.
ClusterId string: The id of the CloudHSM cluster.
HsmType string: The type of HSM module in the cluster. Currently, only hsm1.medium is supported.
SecurityGroupId string: The ID of the security group associated with the CloudHSM cluster.
SourceBackupIdentifier string: The id of Cloud HSM v2 cluster backup to be restored.
State string: The state of the cluster.
SubnetIds List<string>: The IDs of subnets in which cluster will operate.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
VpcId string: The id of the VPC that the CloudHSM cluster resides in.

ClusterCertificates []ClusterClusterCertificate: 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 after an hsm instance is added to the cluster. * 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.
ClusterId string: The id of the CloudHSM cluster.
ClusterState string: The state of the cluster.
HsmType string: The type of HSM module in the cluster. Currently, only hsm1.medium is supported.
SecurityGroupId string: The ID of the security group associated with the CloudHSM cluster.
SourceBackupIdentifier string: The id of Cloud HSM v2 cluster backup to be restored.
SubnetIds []string: The IDs of subnets in which cluster will operate.
Tags map[string]string: A map of tags to assign to the resource.
VpcId string: The id of the VPC that the CloudHSM cluster resides in.

clusterCertificates ClusterClusterCertificate[]: 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 after an hsm instance is added to the cluster. * 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.
clusterId string: The id of the CloudHSM cluster.
clusterState string: The state of the cluster.
hsmType string: The type of HSM module in the cluster. Currently, only hsm1.medium is supported.
securityGroupId string: The ID of the security group associated with the CloudHSM cluster.
sourceBackupIdentifier string: The id of Cloud HSM v2 cluster backup to be restored.
subnetIds string[]: The IDs of subnets in which cluster will operate.
tags {[key: string]: string}: A map of tags to assign to the resource.
vpcId string: The id of the VPC that the CloudHSM cluster resides in.

cluster_certificates List[ClusterClusterCertificate]: 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 after an hsm instance is added to the cluster. * 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.
cluster_id str: The id of the CloudHSM cluster.
cluster_state str: The state of the cluster.
hsm_type str: The type of HSM module in the cluster. Currently, only hsm1.medium is supported.
security_group_id str: The ID of the security group associated with the CloudHSM cluster.
source_backup_identifier str: The id of Cloud HSM v2 cluster backup to be restored.
subnet_ids List[str]: The IDs of subnets in which cluster will operate.
tags Dict[str, str]: A map of tags to assign to the resource.
vpc_id str: The id of the VPC that the CloudHSM cluster resides in.

Supporting Types

ClusterClusterCertificate

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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud