aws logo
AWS Classic v5.29.0, Feb 1 23

aws.redshift.HsmConfiguration

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

using System.Collections.Generic;
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/v5/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
	})
}
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.List;
import java.util.ArrayList;
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());

    }
}
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")
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",
});
resources:
  example:
    type: aws:redshift:HsmConfiguration
    properties:
      description: example
      hsmConfigurationIdentifier: example
      hsmIpAddress: 10.0.0.1
      hsmPartitionName: aws
      hsmPartitionPassword: example
      hsmServerPublicCertificate: example

Create HsmConfiguration Resource

new HsmConfiguration(name: string, args: HsmConfigurationArgs, opts?: CustomResourceOptions);
@overload
def HsmConfiguration(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     hsm_configuration_identifier: Optional[str] = None,
                     hsm_ip_address: Optional[str] = None,
                     hsm_partition_name: Optional[str] = None,
                     hsm_partition_password: Optional[str] = None,
                     hsm_server_public_certificate: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
@overload
def HsmConfiguration(resource_name: str,
                     args: HsmConfigurationArgs,
                     opts: Optional[ResourceOptions] = None)
func NewHsmConfiguration(ctx *Context, name string, args HsmConfigurationArgs, opts ...ResourceOption) (*HsmConfiguration, error)
public HsmConfiguration(string name, HsmConfigurationArgs args, CustomResourceOptions? opts = null)
public HsmConfiguration(String name, HsmConfigurationArgs args)
public HsmConfiguration(String name, HsmConfigurationArgs args, CustomResourceOptions options)
type: aws:redshift:HsmConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args HsmConfigurationArgs
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 HsmConfigurationArgs
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 HsmConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args HsmConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args HsmConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

HsmConfiguration 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 HsmConfiguration resource accepts the following input properties:

Description string

A text description of the HSM configuration to be created.

HsmConfigurationIdentifier string

The identifier to be assigned to the new Amazon Redshift HSM configuration.

HsmIpAddress string

The IP address that the Amazon Redshift cluster must use to access the HSM.

HsmPartitionName string

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

HsmPartitionPassword string

The password required to access the HSM partition.

HsmServerPublicCertificate string

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

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

Description string

A text description of the HSM configuration to be created.

HsmConfigurationIdentifier string

The identifier to be assigned to the new Amazon Redshift HSM configuration.

HsmIpAddress string

The IP address that the Amazon Redshift cluster must use to access the HSM.

HsmPartitionName string

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

HsmPartitionPassword string

The password required to access the HSM partition.

HsmServerPublicCertificate string

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

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

description String

A text description of the HSM configuration to be created.

hsmConfigurationIdentifier String

The identifier to be assigned to the new Amazon Redshift HSM configuration.

hsmIpAddress String

The IP address that the Amazon Redshift cluster must use to access the HSM.

hsmPartitionName String

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hsmPartitionPassword String

The password required to access the HSM partition.

hsmServerPublicCertificate String

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

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

description string

A text description of the HSM configuration to be created.

hsmConfigurationIdentifier string

The identifier to be assigned to the new Amazon Redshift HSM configuration.

hsmIpAddress string

The IP address that the Amazon Redshift cluster must use to access the HSM.

hsmPartitionName string

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hsmPartitionPassword string

The password required to access the HSM partition.

hsmServerPublicCertificate string

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

tags {[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.

description str

A text description of the HSM configuration to be created.

hsm_configuration_identifier str

The identifier to be assigned to the new Amazon Redshift HSM configuration.

hsm_ip_address str

The IP address that the Amazon Redshift cluster must use to access the HSM.

hsm_partition_name str

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hsm_partition_password str

The password required to access the HSM partition.

hsm_server_public_certificate str

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

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

description String

A text description of the HSM configuration to be created.

hsmConfigurationIdentifier String

The identifier to be assigned to the new Amazon Redshift HSM configuration.

hsmIpAddress String

The IP address that the Amazon Redshift cluster must use to access the HSM.

hsmPartitionName String

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hsmPartitionPassword String

The password required to access the HSM partition.

hsmServerPublicCertificate String

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

tags 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 HsmConfiguration resource produces the following output properties:

Arn string

Amazon Resource Name (ARN) of the Hsm Client Certificate.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

Amazon Resource Name (ARN) of the Hsm Client Certificate.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Amazon Resource Name (ARN) of the Hsm Client Certificate.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

Amazon Resource Name (ARN) of the Hsm Client Certificate.

id string

The provider-assigned unique ID for this managed resource.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

Amazon Resource Name (ARN) of the Hsm Client Certificate.

id str

The provider-assigned unique ID for this managed resource.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Amazon Resource Name (ARN) of the Hsm Client Certificate.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing HsmConfiguration Resource

Get an existing HsmConfiguration 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?: HsmConfigurationState, opts?: CustomResourceOptions): HsmConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        hsm_configuration_identifier: Optional[str] = None,
        hsm_ip_address: Optional[str] = None,
        hsm_partition_name: Optional[str] = None,
        hsm_partition_password: Optional[str] = None,
        hsm_server_public_certificate: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> HsmConfiguration
func GetHsmConfiguration(ctx *Context, name string, id IDInput, state *HsmConfigurationState, opts ...ResourceOption) (*HsmConfiguration, error)
public static HsmConfiguration Get(string name, Input<string> id, HsmConfigurationState? state, CustomResourceOptions? opts = null)
public static HsmConfiguration get(String name, Output<String> id, HsmConfigurationState 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.
The following state arguments are supported:
Arn string

Amazon Resource Name (ARN) of the Hsm Client Certificate.

Description string

A text description of the HSM configuration to be created.

HsmConfigurationIdentifier string

The identifier to be assigned to the new Amazon Redshift HSM configuration.

HsmIpAddress string

The IP address that the Amazon Redshift cluster must use to access the HSM.

HsmPartitionName string

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

HsmPartitionPassword string

The password required to access the HSM partition.

HsmServerPublicCertificate string

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

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

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

Amazon Resource Name (ARN) of the Hsm Client Certificate.

Description string

A text description of the HSM configuration to be created.

HsmConfigurationIdentifier string

The identifier to be assigned to the new Amazon Redshift HSM configuration.

HsmIpAddress string

The IP address that the Amazon Redshift cluster must use to access the HSM.

HsmPartitionName string

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

HsmPartitionPassword string

The password required to access the HSM partition.

HsmServerPublicCertificate string

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

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

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Amazon Resource Name (ARN) of the Hsm Client Certificate.

description String

A text description of the HSM configuration to be created.

hsmConfigurationIdentifier String

The identifier to be assigned to the new Amazon Redshift HSM configuration.

hsmIpAddress String

The IP address that the Amazon Redshift cluster must use to access the HSM.

hsmPartitionName String

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hsmPartitionPassword String

The password required to access the HSM partition.

hsmServerPublicCertificate String

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

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

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

Amazon Resource Name (ARN) of the Hsm Client Certificate.

description string

A text description of the HSM configuration to be created.

hsmConfigurationIdentifier string

The identifier to be assigned to the new Amazon Redshift HSM configuration.

hsmIpAddress string

The IP address that the Amazon Redshift cluster must use to access the HSM.

hsmPartitionName string

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hsmPartitionPassword string

The password required to access the HSM partition.

hsmServerPublicCertificate string

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

tags {[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.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

Amazon Resource Name (ARN) of the Hsm Client Certificate.

description str

A text description of the HSM configuration to be created.

hsm_configuration_identifier str

The identifier to be assigned to the new Amazon Redshift HSM configuration.

hsm_ip_address str

The IP address that the Amazon Redshift cluster must use to access the HSM.

hsm_partition_name str

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hsm_partition_password str

The password required to access the HSM partition.

hsm_server_public_certificate str

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

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

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Amazon Resource Name (ARN) of the Hsm Client Certificate.

description String

A text description of the HSM configuration to be created.

hsmConfigurationIdentifier String

The identifier to be assigned to the new Amazon Redshift HSM configuration.

hsmIpAddress String

The IP address that the Amazon Redshift cluster must use to access the HSM.

hsmPartitionName String

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hsmPartitionPassword String

The password required to access the HSM partition.

hsmServerPublicCertificate String

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

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

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Import

Redshift Hsm Client Certificates support import by hsm_configuration_identifier, e.g., console

 $ pulumi import aws:redshift/hsmConfiguration:HsmConfiguration example example

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.