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

Inheritance

System.Object

Resource

CustomResource

Cluster

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.CloudHsmV2

Assembly: Pulumi.Aws.dll

Syntax

public class Cluster : CustomResource

Constructors

Cluster(String, ClusterArgs, CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClusterArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ClusterCertificates

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.

Declaration

public Output<ImmutableArray<ClusterClusterCertificate>> ClusterCertificates { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ClusterClusterCertificate>>

ClusterId

The id of the CloudHSM cluster.

Declaration

public Output<string> ClusterId { get; }

Property Value

Type	Description
Output<System.String>

HsmType

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

Declaration

public Output<string> HsmType { get; }

Property Value

Type	Description
Output<System.String>

SecurityGroupId

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

Declaration

public Output<string> SecurityGroupId { get; }

Property Value

Type	Description
Output<System.String>

SourceBackupIdentifier

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

Declaration

public Output<string> SourceBackupIdentifier { get; }

Property Value

Type	Description
Output<System.String>

State

The state of the cluster.

Declaration

public Output<string> State { get; }

Property Value

Type	Description
Output<System.String>

SubnetIds

The IDs of subnets in which cluster will operate.

Declaration

public Output<ImmutableArray<string>> SubnetIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

VpcId

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

Declaration

public Output<string> VpcId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ClusterState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ClusterState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Cluster