Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cloudhsmv2
  5. Cluster
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

aws.cloudhsmv2.Cluster

Explore with Pulumi AI

aws logo
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

    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: A CloudHSM Cluster can take several minutes to set up. Practically no single attribute can be updated, except for 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.

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            hsm_type: Optional[str] = None,
            subnet_ids: Optional[Sequence[str]] = None,
            mode: Optional[str] = None,
            source_backup_identifier: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: aws:cloudhsmv2:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var clusterResource = new Aws.CloudHsmV2.Cluster("clusterResource", new()
{
    HsmType = "string",
    SubnetIds = new[]
    {
        "string",
    },
    Mode = "string",
    SourceBackupIdentifier = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cloudhsmv2.NewCluster(ctx, "clusterResource", &cloudhsmv2.ClusterArgs{
	HsmType: pulumi.String("string"),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Mode:                   pulumi.String("string"),
	SourceBackupIdentifier: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var clusterResource = new com.pulumi.aws.cloudhsmv2.Cluster("clusterResource", com.pulumi.aws.cloudhsmv2.ClusterArgs.builder()
    .hsmType("string")
    .subnetIds("string")
    .mode("string")
    .sourceBackupIdentifier("string")
    .tags(Map.of("string", "string"))
    .build());

    cluster_resource = aws.cloudhsmv2.Cluster("clusterResource",
    hsm_type="string",
    subnet_ids=["string"],
    mode="string",
    source_backup_identifier="string",
    tags={
        "string": "string",
    })

    const clusterResource = new aws.cloudhsmv2.Cluster("clusterResource", {
    hsmType: "string",
    subnetIds: ["string"],
    mode: "string",
    sourceBackupIdentifier: "string",
    tags: {
        string: "string",
    },
});

    type: aws:cloudhsmv2:Cluster
properties:
    hsmType: string
    mode: string
    sourceBackupIdentifier: string
    subnetIds:
        - string
    tags:
        string: string

    Cluster Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Cluster resource accepts the following input properties:

    HsmType string
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    SubnetIds List<string>
    The IDs of subnets in which cluster will operate.
    Mode string
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    SourceBackupIdentifier string
    ID of Cloud HSM v2 cluster backup to be restored.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    HsmType string
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    SubnetIds []string
    The IDs of subnets in which cluster will operate.
    Mode string
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    SourceBackupIdentifier string
    ID of Cloud HSM v2 cluster backup to be restored.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    hsmType String
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    subnetIds List<String>
    The IDs of subnets in which cluster will operate.
    mode String
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    sourceBackupIdentifier String
    ID of Cloud HSM v2 cluster backup to be restored.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    hsmType string
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    subnetIds string[]
    The IDs of subnets in which cluster will operate.
    mode string
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    sourceBackupIdentifier string
    ID of Cloud HSM v2 cluster backup to be restored.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    hsm_type str
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    subnet_ids Sequence[str]
    The IDs of subnets in which cluster will operate.
    mode str
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    source_backup_identifier str
    ID of Cloud HSM v2 cluster backup to be restored.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    hsmType String
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    subnetIds List<String>
    The IDs of subnets in which cluster will operate.
    mode String
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    sourceBackupIdentifier String
    ID of Cloud HSM v2 cluster backup to be restored.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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.
    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 CloudHSM cluster.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcId string
    The id of the VPC that the CloudHSM cluster resides in.
    ClusterCertificates []ClusterClusterCertificate
    The list of cluster certificates.
    ClusterId string
    The id of the CloudHSM cluster.
    ClusterState string
    The state 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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcId string
    The id of the VPC that the CloudHSM cluster resides in.
    clusterCertificates List<ClusterClusterCertificate>
    The list of cluster certificates.
    clusterId String
    The id of the CloudHSM cluster.
    clusterState String
    The state 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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcId String
    The id of the VPC that the CloudHSM cluster resides in.
    clusterCertificates ClusterClusterCertificate[]
    The list of cluster certificates.
    clusterId string
    The id of the CloudHSM cluster.
    clusterState string
    The state 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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcId string
    The id of the VPC that the CloudHSM cluster resides in.
    cluster_certificates Sequence[ClusterClusterCertificate]
    The list of cluster certificates.
    cluster_id str
    The id of the CloudHSM cluster.
    cluster_state str
    The state of the CloudHSM 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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpc_id str
    The id of the VPC that the CloudHSM cluster resides in.
    clusterCertificates List<Property Map>
    The list of cluster certificates.
    clusterId String
    The id of the CloudHSM cluster.
    clusterState String
    The state 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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

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

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_certificates: Optional[Sequence[ClusterClusterCertificateArgs]] = None,
        cluster_id: Optional[str] = None,
        cluster_state: Optional[str] = None,
        hsm_type: Optional[str] = None,
        mode: Optional[str] = None,
        security_group_id: Optional[str] = None,
        source_backup_identifier: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None) -> Cluster
    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)
    public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
    resources:  _:    type: aws:cloudhsmv2:Cluster    get:      id: ${id}
    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.
    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<ClusterClusterCertificate>
    The list of cluster certificates.
    ClusterId string
    The id of the CloudHSM cluster.
    HsmType string
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    Mode string
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    SecurityGroupId string
    The ID of the security group associated with the CloudHSM cluster.
    SourceBackupIdentifier string
    ID of Cloud HSM v2 cluster backup to be restored.
    State string
    The state of the CloudHSM 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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcId string
    The id of the VPC that the CloudHSM cluster resides in.
    ClusterCertificates []ClusterClusterCertificateArgs
    The list of cluster certificates.
    ClusterId string
    The id of the CloudHSM cluster.
    ClusterState string
    The state of the CloudHSM cluster.
    HsmType string
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    Mode string
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    SecurityGroupId string
    The ID of the security group associated with the CloudHSM cluster.
    SourceBackupIdentifier string
    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcId string
    The id of the VPC that the CloudHSM cluster resides in.
    clusterCertificates List<ClusterClusterCertificate>
    The list of cluster certificates.
    clusterId String
    The id of the CloudHSM cluster.
    clusterState String
    The state of the CloudHSM cluster.
    hsmType String
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    mode String
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    securityGroupId String
    The ID of the security group associated with the CloudHSM cluster.
    sourceBackupIdentifier String
    ID of Cloud HSM v2 cluster backup to be restored.
    subnetIds List<String>
    The IDs of subnets in which cluster will operate.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcId String
    The id of the VPC that the CloudHSM cluster resides in.
    clusterCertificates ClusterClusterCertificate[]
    The list of cluster certificates.
    clusterId string
    The id of the CloudHSM cluster.
    clusterState string
    The state of the CloudHSM cluster.
    hsmType string
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    mode string
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    securityGroupId string
    The ID of the security group associated with the CloudHSM cluster.
    sourceBackupIdentifier string
    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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcId string
    The id of the VPC that the CloudHSM cluster resides in.
    cluster_certificates Sequence[ClusterClusterCertificateArgs]
    The list of cluster certificates.
    cluster_id str
    The id of the CloudHSM cluster.
    cluster_state str
    The state of the CloudHSM cluster.
    hsm_type str
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    mode str
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    security_group_id str
    The ID of the security group associated with the CloudHSM cluster.
    source_backup_identifier str
    ID of Cloud HSM v2 cluster backup to be restored.
    subnet_ids Sequence[str]
    The IDs of subnets in which cluster will operate.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpc_id str
    The id of the VPC that the CloudHSM cluster resides in.
    clusterCertificates List<Property Map>
    The list of cluster certificates.
    clusterId String
    The id of the CloudHSM cluster.
    clusterState String
    The state of the CloudHSM cluster.
    hsmType String
    The type of HSM module in the cluster. Currently, hsm1.medium and hsm2m.medium are supported.
    mode String
    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. This field is required if hsm_type is hsm2m.medium.
    securityGroupId String
    The ID of the security group associated with the CloudHSM cluster.
    sourceBackupIdentifier String
    ID of Cloud HSM v2 cluster backup to be restored.
    subnetIds List<String>
    The IDs of subnets in which cluster will operate.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

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

    Supporting Types

    ClusterClusterCertificate, ClusterClusterCertificateArgs

    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 after an HSM instance is added to the cluster.
    HsmCertificate string
    The HSM certificate issued (signed) by the HSM hardware.
    ManufacturerHardwareCertificate string
    The HSM hardware certificate issued (signed) by the hardware manufacturer.
    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 after an HSM instance is added to the cluster.
    HsmCertificate string
    The HSM certificate issued (signed) by the HSM hardware.
    ManufacturerHardwareCertificate string
    The HSM hardware certificate issued (signed) by the hardware manufacturer.
    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 after an HSM instance is added to the cluster.
    hsmCertificate String
    The HSM certificate issued (signed) by the HSM hardware.
    manufacturerHardwareCertificate String
    The HSM hardware certificate issued (signed) by the hardware manufacturer.
    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 after an HSM instance is added to the cluster.
    hsmCertificate string
    The HSM certificate issued (signed) by the HSM hardware.
    manufacturerHardwareCertificate string
    The HSM hardware certificate issued (signed) by the hardware manufacturer.
    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 after an HSM instance is added to the cluster.
    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.
    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 after an HSM instance is added to the cluster.
    hsmCertificate String
    The HSM certificate issued (signed) by the HSM hardware.
    manufacturerHardwareCertificate String
    The HSM hardware certificate issued (signed) by the hardware manufacturer.

    Import

    Using pulumi import, import CloudHSM v2 Clusters using the cluster id. For example:

    $ pulumi import aws:cloudhsmv2/cluster:Cluster test_cluster cluster-aeb282a201

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
    pulumi/pulumi-aws