HsmConfiguration class
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM).
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.redshift.HsmConfiguration("example", {
description: "example",
hsmConfigurationIdentifier: "example",
hsmIpAddress: "10.0.0.1",
hsmPartitionName: "aws",
hsmPartitionPassword: "example",
hsmServerPublicCertificate: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.redshift.HsmConfiguration("example",
description="example",
hsm_configuration_identifier="example",
hsm_ip_address="10.0.0.1",
hsm_partition_name="aws",
hsm_partition_password="example",
hsm_server_public_certificate="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.RedShift.HsmConfiguration("example", new()
{
Description = "example",
HsmConfigurationIdentifier = "example",
HsmIpAddress = "10.0.0.1",
HsmPartitionName = "aws",
HsmPartitionPassword = "example",
HsmServerPublicCertificate = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/redshift"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := redshift.NewHsmConfiguration(ctx, "example", &redshift.HsmConfigurationArgs{
Description: pulumi.String("example"),
HsmConfigurationIdentifier: pulumi.String("example"),
HsmIpAddress: pulumi.String("10.0.0.1"),
HsmPartitionName: pulumi.String("aws"),
HsmPartitionPassword: pulumi.String("example"),
HsmServerPublicCertificate: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_redshift_hsmconfiguration" "example" {
description = "example"
hsm_configuration_identifier = "example"
hsm_ip_address = "10.0.0.1"
hsm_partition_name = "aws"
hsm_partition_password = "example"
hsm_server_public_certificate = "example"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.HsmConfiguration;
import com.pulumi.aws.redshift.HsmConfigurationArgs;
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) {
var example = new HsmConfiguration("example", HsmConfigurationArgs.builder()
.description("example")
.hsmConfigurationIdentifier("example")
.hsmIpAddress("10.0.0.1")
.hsmPartitionName("aws")
.hsmPartitionPassword("example")
.hsmServerPublicCertificate("example")
.build());
}
}
resources:
example:
type: aws:redshift:HsmConfiguration
properties:
description: example
hsmConfigurationIdentifier: example
hsmIpAddress: 10.0.0.1
hsmPartitionName: aws
hsmPartitionPassword: example
hsmServerPublicCertificate: example
Import
Using pulumi import, import Redshift HSM Client Certificates using hsmConfigurationIdentifier. For example:
$ pulumi import aws:redshift/hsmConfiguration:HsmConfiguration example example
Constructors
- HsmConfiguration(String name, {HsmConfigurationArgs? args, CustomResourceOptions? options})
-
Creates a new HsmConfiguration.
nameThe Pulumi resource name.argsArguments used to configure this HsmConfiguration. The set of arguments for HsmConfiguration.optionsResource options controlling this resource's behavior. - HsmConfiguration.reference(String urn)
- Creates a typed reference to an existing HsmConfiguration resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Hsm Client Certificate.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String> -
A text description of the HSM configuration to be created.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
hsmConfigurationIdentifier
↔ Output<
String> -
The identifier to be assigned to the new Amazon Redshift HSM configuration.
latefinal
-
hsmIpAddress
↔ Output<
String> -
The IP address that the Amazon Redshift cluster must use to access the HSM.
latefinal
-
hsmPartitionName
↔ Output<
String> -
The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
latefinal
-
hsmPartitionPassword
↔ Output<
String> -
The password required to access the HSM partition.
latefinal
-
hsmServerPublicCertificate
↔ Output<
String> -
The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
- 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
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.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
Static Methods
-
get(
String name, Input< String> id, {HsmConfigurationState? state, CustomResourceOptions? options}) → HsmConfiguration -
Gets an existing HsmConfiguration resource's state with the given
nameandid.