AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

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: 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 a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            hsm_type: Optional[str] = None,
            source_backup_identifier: Optional[str] = None,
            subnet_ids: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = 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.

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.

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

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. .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, 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. .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, 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 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, 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. .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, only hsm1.medium is supported.

subnet_ids Sequence[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 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, 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 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.

  • 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 CloudHSM cluster.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

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

VpcId string

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

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.

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 .

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

vpcId string

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

cluster_certificates Sequence[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 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 .

vpc_id str

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

vpcId String

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
@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,
        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)
Resource lookup is not supported in YAML
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<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 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 .

VpcId string

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

ClusterCertificates []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.

ClusterState string

The state 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.

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 .

VpcId string

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

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.

clusterState String

The state 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.

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 .

vpcId String

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

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

clusterState string

The state 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.

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 .

vpcId string

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

cluster_certificates Sequence[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.
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, 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 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 .

vpc_id str

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

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 .

vpcId String

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

Supporting Types

ClusterClusterCertificate

Import

CloudHSM v2 Clusters can be imported using the cluster id, e.g.,

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

Package Details

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

This Pulumi package is based on the aws Terraform Provider.