Try AWS Native preview for resources not in the classic version.
aws.cloudhsmv2.Cluster
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
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
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:
- Hsm
Type string The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- Subnet
Ids List<string> The IDs of subnets in which cluster will operate.
- Source
Backup stringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- 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.
- Hsm
Type string The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- Subnet
Ids []string The IDs of subnets in which cluster will operate.
- Source
Backup stringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- 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.
- hsm
Type String The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- subnet
Ids List<String> The IDs of subnets in which cluster will operate.
- source
Backup StringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- 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.
- hsm
Type string The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- subnet
Ids string[] The IDs of subnets in which cluster will operate.
- source
Backup stringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- {[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_ stridentifier ID of Cloud HSM v2 cluster backup to be restored.
- 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.
- hsm
Type String The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- subnet
Ids List<String> The IDs of subnets in which cluster will operate.
- source
Backup StringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- 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:
- Cluster
Certificates List<ClusterCluster Certificate> 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 inUNINITIALIZED
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 string The id of the CloudHSM cluster.
- Id string
The provider-assigned unique ID for this managed resource.
- Security
Group stringId The ID of the security group associated with the CloudHSM cluster.
- State string
The state of the CloudHSM cluster.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Vpc
Id string The id of the VPC that the CloudHSM cluster resides in.
- Cluster
Certificates []ClusterCluster Certificate 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 inUNINITIALIZED
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 string The id of the CloudHSM cluster.
- Cluster
State string The state of the CloudHSM cluster.
- Id string
The provider-assigned unique ID for this managed resource.
- Security
Group stringId The ID of the security group associated with the CloudHSM cluster.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Vpc
Id string The id of the VPC that the CloudHSM cluster resides in.
- cluster
Certificates List<ClusterCluster Certificate> 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 inUNINITIALIZED
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 String The id of the CloudHSM cluster.
- cluster
State String The state of the CloudHSM cluster.
- id String
The provider-assigned unique ID for this managed resource.
- security
Group StringId The ID of the security group associated with the CloudHSM cluster.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- vpc
Id String The id of the VPC that the CloudHSM cluster resides in.
- cluster
Certificates ClusterCluster Certificate[] 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 inUNINITIALIZED
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 string The id of the CloudHSM cluster.
- cluster
State string The state of the CloudHSM cluster.
- id string
The provider-assigned unique ID for this managed resource.
- security
Group stringId The ID of the security group associated with the CloudHSM cluster.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- vpc
Id string The id of the VPC that the CloudHSM cluster resides in.
- cluster_
certificates Sequence[ClusterCluster Certificate] 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 inUNINITIALIZED
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_ strid The ID of the security group associated with the CloudHSM cluster.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- vpc_
id str The id of the VPC that the CloudHSM cluster resides in.
- cluster
Certificates 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 inUNINITIALIZED
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 String The id of the CloudHSM cluster.
- cluster
State String The state of the CloudHSM cluster.
- id String
The provider-assigned unique ID for this managed resource.
- security
Group StringId The ID of the security group associated with the CloudHSM cluster.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- vpc
Id 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,
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.
- Cluster
Certificates List<ClusterCluster Certificate Args> 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 inUNINITIALIZED
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 string The id of the CloudHSM cluster.
- Hsm
Type string The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- Security
Group stringId The ID of the security group associated with the CloudHSM cluster.
- Source
Backup stringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- State string
The state of the CloudHSM cluster.
- Subnet
Ids List<string> The IDs of subnets in which cluster will operate.
- 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Vpc
Id string The id of the VPC that the CloudHSM cluster resides in.
- Cluster
Certificates []ClusterCluster Certificate Args 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 inUNINITIALIZED
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 string The id of the CloudHSM cluster.
- Cluster
State string The state of the CloudHSM cluster.
- Hsm
Type string The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- Security
Group stringId The ID of the security group associated with the CloudHSM cluster.
- Source
Backup stringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- Subnet
Ids []string The IDs of subnets in which cluster will operate.
- 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Vpc
Id string The id of the VPC that the CloudHSM cluster resides in.
- cluster
Certificates List<ClusterCluster Certificate Args> 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 inUNINITIALIZED
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 String The id of the CloudHSM cluster.
- cluster
State String The state of the CloudHSM cluster.
- hsm
Type String The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- security
Group StringId The ID of the security group associated with the CloudHSM cluster.
- source
Backup StringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- subnet
Ids List<String> The IDs of subnets in which cluster will operate.
- 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- vpc
Id String The id of the VPC that the CloudHSM cluster resides in.
- cluster
Certificates ClusterCluster Certificate Args[] 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 inUNINITIALIZED
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 string The id of the CloudHSM cluster.
- cluster
State string The state of the CloudHSM cluster.
- hsm
Type string The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- security
Group stringId The ID of the security group associated with the CloudHSM cluster.
- source
Backup stringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- subnet
Ids string[] The IDs of subnets in which cluster will operate.
- {[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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- vpc
Id string The id of the VPC that the CloudHSM cluster resides in.
- cluster_
certificates Sequence[ClusterCluster Certificate Args] 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 inUNINITIALIZED
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_ strid The ID of the security group associated with the CloudHSM cluster.
- source_
backup_ stridentifier ID of Cloud HSM v2 cluster backup to be restored.
- subnet_
ids Sequence[str] The IDs of subnets in which cluster will operate.
- 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- vpc_
id str The id of the VPC that the CloudHSM cluster resides in.
- cluster
Certificates 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 inUNINITIALIZED
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 String The id of the CloudHSM cluster.
- cluster
State String The state of the CloudHSM cluster.
- hsm
Type String The type of HSM module in the cluster. Currently, only
hsm1.medium
is supported.- security
Group StringId The ID of the security group associated with the CloudHSM cluster.
- source
Backup StringIdentifier ID of Cloud HSM v2 cluster backup to be restored.
- subnet
Ids List<String> The IDs of subnets in which cluster will operate.
- 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- vpc
Id String The id of the VPC that the CloudHSM cluster resides in.
Supporting Types
ClusterClusterCertificate
- Aws
Hardware stringCertificate - Cluster
Certificate string - Cluster
Csr string - Hsm
Certificate string - Manufacturer
Hardware stringCertificate
- Aws
Hardware stringCertificate - Cluster
Certificate string - Cluster
Csr string - Hsm
Certificate string - Manufacturer
Hardware stringCertificate
- aws
Hardware StringCertificate - cluster
Certificate String - cluster
Csr String - hsm
Certificate String - manufacturer
Hardware StringCertificate
- aws
Hardware stringCertificate - cluster
Certificate string - cluster
Csr string - hsm
Certificate string - manufacturer
Hardware stringCertificate
- aws
Hardware StringCertificate - cluster
Certificate String - cluster
Csr String - hsm
Certificate String - manufacturer
Hardware StringCertificate
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
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.