Hsm class
Creates an HSM module in Amazon CloudHSM v2 cluster.
Example Usage
The following example below creates an HSM module in CloudHSM cluster.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const cluster = aws.cloudhsmv2.getCluster({
clusterId: cloudhsmClusterId,
});
const cloudhsmV2Hsm = new aws.cloudhsmv2.Hsm("cloudhsm_v2_hsm", {
subnetId: cluster.then(cluster => cluster.subnetIds?.[0]),
clusterId: cluster.then(cluster => cluster.clusterId),
});
import pulumi
import pulumi_aws as aws
cluster = aws.cloudhsmv2.get_cluster(cluster_id=cloudhsm_cluster_id)
cloudhsm_v2_hsm = aws.cloudhsmv2.Hsm("cloudhsm_v2_hsm",
subnet_id=cluster.subnet_ids[0],
cluster_id=cluster.cluster_id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var cluster = Aws.CloudHsmV2.GetCluster.Invoke(new()
{
ClusterId = cloudhsmClusterId,
});
var cloudhsmV2Hsm = new Aws.CloudHsmV2.Hsm("cloudhsm_v2_hsm", new()
{
SubnetId = cluster.Apply(getClusterResult => getClusterResult.SubnetIds[0]),
ClusterId = cluster.Apply(getClusterResult => getClusterResult.ClusterId),
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudhsmv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cluster, err := cloudhsmv2.LookupCluster(ctx, &cloudhsmv2.LookupClusterArgs{
ClusterId: cloudhsmClusterId,
}, nil)
if err != nil {
return err
}
_, err = cloudhsmv2.NewHsm(ctx, "cloudhsm_v2_hsm", &cloudhsmv2.HsmArgs{
SubnetId: pulumi.String(cluster.SubnetIds[0]),
ClusterId: pulumi.String(cluster.ClusterId),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_cloudhsmv2_getcluster" "cluster" {
cluster_id = cloudhsmClusterId
}
resource "aws_cloudhsmv2_hsm" "cloudhsm_v2_hsm" {
subnet_id = data.aws_cloudhsmv2_getcluster.cluster.subnet_ids[0]
cluster_id = data.aws_cloudhsmv2_getcluster.cluster.cluster_id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudhsmv2.Cloudhsmv2Functions;
import com.pulumi.aws.cloudhsmv2.inputs.GetClusterArgs;
import com.pulumi.aws.cloudhsmv2.Hsm;
import com.pulumi.aws.cloudhsmv2.HsmArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var cluster = Cloudhsmv2Functions.getCluster(GetClusterArgs.builder()
.clusterId(cloudhsmClusterId)
.build());
var cloudhsmV2Hsm = new Hsm("cloudhsmV2Hsm", HsmArgs.builder()
.subnetId(cluster.subnetIds()[0])
.clusterId(cluster.clusterId())
.build());
}
}
resources:
cloudhsmV2Hsm:
type: aws:cloudhsmv2:Hsm
name: cloudhsm_v2_hsm
properties:
subnetId: ${cluster.subnetIds[0]}
clusterId: ${cluster.clusterId}
variables:
cluster:
fn::invoke:
function: aws:cloudhsmv2:getCluster
arguments:
clusterId: ${cloudhsmClusterId}
Import
Using pulumi import, import HSM modules using their HSM ID. For example:
$ pulumi import aws:cloudhsmv2/hsm:Hsm bar hsm-quo8dahtaca
Constructors
- Hsm(String name, {HsmArgs? args, CustomResourceOptions? options})
-
Creates a new Hsm.
nameThe Pulumi resource name.argsArguments used to configure this Hsm. The set of arguments for Hsm.optionsResource options controlling this resource's behavior. - Hsm.reference(String urn)
- Creates a typed reference to an existing Hsm resource.
Properties
-
availabilityZone
↔ Output<
String> -
The IDs of AZ in which HSM module will be located. Conflicts with
subnetId.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
clusterId
↔ Output<
String> -
The ID of Cloud HSM v2 cluster to which HSM will be added.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
hsmEniId
↔ Output<
String> -
The id of the ENI interface allocated for HSM module.
latefinal
-
hsmId
↔ Output<
String> -
The id of the HSM module.
latefinal
-
hsmState
↔ Output<
String> -
The state of the HSM module.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
-
ipAddress
↔ Output<
String> -
The IP address of HSM module. Must be within the CIDR of selected subnet.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
subnetId
↔ Output<
String> -
The ID of subnet in which HSM module will be located. Conflicts with
availabilityZone.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited