cloudhsmv2

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.cloudhsmv2.AwaitableGetClusterResult(cluster_certificates=None, cluster_id=None, cluster_state=None, security_group_id=None, subnet_ids=None, vpc_id=None, id=None)
class pulumi_aws.cloudhsmv2.Cluster(resource_name, opts=None, hsm_type=None, source_backup_identifier=None, subnet_ids=None, tags=None, __props__=None, __name__=None, __opts__=None)

Creates an Amazon CloudHSM v2 cluster.

For information about CloudHSM v2, see the [AWS CloudHSM User Guide][1] 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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • hsm_type (pulumi.Input[str]) – The type of HSM module in the cluster. Currently, only hsm1.medium is supported.

  • source_backup_identifier (pulumi.Input[str]) – The id of Cloud HSM v2 cluster backup to be restored.

  • subnet_ids (pulumi.Input[list]) – The IDs of subnets in which cluster will operate.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

cluster_certificates = None

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.

    • awsHardwareCertificate (str)

    • clusterCertificate (str)

    • clusterCsr (str)

    • hsmCertificate (str)

    • manufacturerHardwareCertificate (str)

cluster_id = None

The id of the CloudHSM cluster.

cluster_state = None

The state of the cluster.

hsm_type = None

The type of HSM module in the cluster. Currently, only hsm1.medium is supported.

security_group_id = None

The ID of the security group associated with the CloudHSM cluster.

source_backup_identifier = None

The id of Cloud HSM v2 cluster backup to be restored.

subnet_ids = None

The IDs of subnets in which cluster will operate.

tags = None

A mapping of tags to assign to the resource.

vpc_id = None

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

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)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_certificates (pulumi.Input[dict]) – 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.
Parameters
  • cluster_id (pulumi.Input[str]) – The id of the CloudHSM cluster.

  • cluster_state (pulumi.Input[str]) – The state of the cluster.

  • hsm_type (pulumi.Input[str]) – The type of HSM module in the cluster. Currently, only hsm1.medium is supported.

  • security_group_id (pulumi.Input[str]) – The ID of the security group associated with the CloudHSM cluster.

  • source_backup_identifier (pulumi.Input[str]) – The id of Cloud HSM v2 cluster backup to be restored.

  • subnet_ids (pulumi.Input[list]) – The IDs of subnets in which cluster will operate.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • vpc_id (pulumi.Input[str]) – The id of the VPC that the CloudHSM cluster resides in.

The cluster_certificates object supports the following:

  • awsHardwareCertificate (pulumi.Input[str])

  • clusterCertificate (pulumi.Input[str])

  • clusterCsr (pulumi.Input[str])

  • hsmCertificate (pulumi.Input[str])

  • manufacturerHardwareCertificate (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.cloudhsmv2.GetClusterResult(cluster_certificates=None, cluster_id=None, cluster_state=None, security_group_id=None, subnet_ids=None, vpc_id=None, id=None)

A collection of values returned by getCluster.

cluster_certificates = None

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.

security_group_id = None

The ID of the security group associated with the CloudHSM cluster.

subnet_ids = None

The IDs of subnets in which cluster operates.

vpc_id = None

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

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.cloudhsmv2.Hsm(resource_name, opts=None, availability_zone=None, cluster_id=None, ip_address=None, subnet_id=None, __props__=None, __name__=None, __opts__=None)

Creates an HSM module in Amazon CloudHSM v2 cluster.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • availability_zone (pulumi.Input[str]) – The IDs of AZ in which HSM module will be located. Do not use together with subnet_id.

  • cluster_id (pulumi.Input[str]) – The ID of Cloud HSM v2 cluster to which HSM will be added.

  • ip_address (pulumi.Input[str]) – The IP address of HSM module. Must be within the CIDR of selected subnet.

  • subnet_id (pulumi.Input[str]) – The ID of subnet in which HSM module will be located.

availability_zone = None

The IDs of AZ in which HSM module will be located. Do not use together with subnet_id.

cluster_id = None

The ID of Cloud HSM v2 cluster to which HSM will be added.

hsm_eni_id = None

The id of the ENI interface allocated for HSM module.

hsm_id = None

The id of the HSM module.

hsm_state = None

The state of the HSM module.

ip_address = None

The IP address of HSM module. Must be within the CIDR of selected subnet.

subnet_id = None

The ID of subnet in which HSM module will be located.

static get(resource_name, id, opts=None, availability_zone=None, cluster_id=None, hsm_eni_id=None, hsm_id=None, hsm_state=None, ip_address=None, subnet_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • availability_zone (pulumi.Input[str]) – The IDs of AZ in which HSM module will be located. Do not use together with subnet_id.

  • cluster_id (pulumi.Input[str]) – The ID of Cloud HSM v2 cluster to which HSM will be added.

  • hsm_eni_id (pulumi.Input[str]) – The id of the ENI interface allocated for HSM module.

  • hsm_id (pulumi.Input[str]) – The id of the HSM module.

  • hsm_state (pulumi.Input[str]) – The state of the HSM module.

  • ip_address (pulumi.Input[str]) – The IP address of HSM module. Must be within the CIDR of selected subnet.

  • subnet_id (pulumi.Input[str]) – The ID of subnet in which HSM module will be located.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_aws.cloudhsmv2.get_cluster(cluster_id=None, cluster_state=None, opts=None)

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

Parameters
  • cluster_id (str) – The id of Cloud HSM v2 cluster.

  • cluster_state (str) – The state of the cluster to be found.