Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. HsmClientCertificate
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.redshift.HsmClientCertificate

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client’s HSM in order to store and retrieve the keys used to encrypt the cluster databases.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshift.HsmClientCertificate("example", {hsmClientCertificateIdentifier: "example"});
Copy
import pulumi
import pulumi_aws as aws

example = aws.redshift.HsmClientCertificate("example", hsm_client_certificate_identifier="example")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshift.NewHsmClientCertificate(ctx, "example", &redshift.HsmClientCertificateArgs{
			HsmClientCertificateIdentifier: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.RedShift.HsmClientCertificate("example", new()
    {
        HsmClientCertificateIdentifier = "example",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.HsmClientCertificate;
import com.pulumi.aws.redshift.HsmClientCertificateArgs;
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 HsmClientCertificate("example", HsmClientCertificateArgs.builder()
            .hsmClientCertificateIdentifier("example")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:redshift:HsmClientCertificate
    properties:
      hsmClientCertificateIdentifier: example
Copy

Create HsmClientCertificate Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new HsmClientCertificate(name: string, args: HsmClientCertificateArgs, opts?: CustomResourceOptions);
@overload
def HsmClientCertificate(resource_name: str,
                         args: HsmClientCertificateArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def HsmClientCertificate(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         hsm_client_certificate_identifier: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
func NewHsmClientCertificate(ctx *Context, name string, args HsmClientCertificateArgs, opts ...ResourceOption) (*HsmClientCertificate, error)
public HsmClientCertificate(string name, HsmClientCertificateArgs args, CustomResourceOptions? opts = null)
public HsmClientCertificate(String name, HsmClientCertificateArgs args)
public HsmClientCertificate(String name, HsmClientCertificateArgs args, CustomResourceOptions options)

type: aws:redshift:HsmClientCertificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HsmClientCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HsmClientCertificateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HsmClientCertificateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HsmClientCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HsmClientCertificateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var hsmClientCertificateResource = new Aws.RedShift.HsmClientCertificate("hsmClientCertificateResource", new()
{
    HsmClientCertificateIdentifier = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := redshift.NewHsmClientCertificate(ctx, "hsmClientCertificateResource", &redshift.HsmClientCertificateArgs{
	HsmClientCertificateIdentifier: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var hsmClientCertificateResource = new HsmClientCertificate("hsmClientCertificateResource", HsmClientCertificateArgs.builder()
    .hsmClientCertificateIdentifier("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
hsm_client_certificate_resource = aws.redshift.HsmClientCertificate("hsmClientCertificateResource",
    hsm_client_certificate_identifier="string",
    tags={
        "string": "string",
    })
Copy
const hsmClientCertificateResource = new aws.redshift.HsmClientCertificate("hsmClientCertificateResource", {
    hsmClientCertificateIdentifier: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:redshift:HsmClientCertificate
properties:
    hsmClientCertificateIdentifier: string
    tags:
        string: string
Copy

HsmClientCertificate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The HsmClientCertificate resource accepts the following input properties:

HsmClientCertificateIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the HSM client certificate.
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.
HsmClientCertificateIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the HSM client certificate.
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.
hsmClientCertificateIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the HSM client certificate.
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.
hsmClientCertificateIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the HSM client certificate.
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.
hsm_client_certificate_identifier
This property is required.
Changes to this property will trigger replacement.
str
The identifier of the HSM client certificate.
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.
hsmClientCertificateIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the HSM client certificate.
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 HsmClientCertificate resource produces the following output properties:

Arn string
Amazon Resource Name (ARN) of the Hsm Client Certificate.
HsmClientCertificatePublicKey string
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the Hsm Client Certificate.
HsmClientCertificatePublicKey string
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the Hsm Client Certificate.
hsmClientCertificatePublicKey String
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the Hsm Client Certificate.
hsmClientCertificatePublicKey string
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the Hsm Client Certificate.
hsm_client_certificate_public_key str
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the Hsm Client Certificate.
hsmClientCertificatePublicKey String
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

Look up Existing HsmClientCertificate Resource

Get an existing HsmClientCertificate 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?: HsmClientCertificateState, opts?: CustomResourceOptions): HsmClientCertificate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        hsm_client_certificate_identifier: Optional[str] = None,
        hsm_client_certificate_public_key: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> HsmClientCertificate
func GetHsmClientCertificate(ctx *Context, name string, id IDInput, state *HsmClientCertificateState, opts ...ResourceOption) (*HsmClientCertificate, error)
public static HsmClientCertificate Get(string name, Input<string> id, HsmClientCertificateState? state, CustomResourceOptions? opts = null)
public static HsmClientCertificate get(String name, Output<String> id, HsmClientCertificateState state, CustomResourceOptions options)
resources:  _:    type: aws:redshift:HsmClientCertificate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
HsmClientCertificateIdentifier Changes to this property will trigger replacement. string
The identifier of the HSM client certificate.
HsmClientCertificatePublicKey string
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the Hsm Client Certificate.
HsmClientCertificateIdentifier Changes to this property will trigger replacement. string
The identifier of the HSM client certificate.
HsmClientCertificatePublicKey string
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the Hsm Client Certificate.
hsmClientCertificateIdentifier Changes to this property will trigger replacement. String
The identifier of the HSM client certificate.
hsmClientCertificatePublicKey String
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the Hsm Client Certificate.
hsmClientCertificateIdentifier Changes to this property will trigger replacement. string
The identifier of the HSM client certificate.
hsmClientCertificatePublicKey string
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the Hsm Client Certificate.
hsm_client_certificate_identifier Changes to this property will trigger replacement. str
The identifier of the HSM client certificate.
hsm_client_certificate_public_key str
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the Hsm Client Certificate.
hsmClientCertificateIdentifier Changes to this property will trigger replacement. String
The identifier of the HSM client certificate.
hsmClientCertificatePublicKey String
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
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.

Deprecated: Please use tags instead.

Import

Using pulumi import, import Redshift HSM Client Certificates using hsm_client_certificate_identifier. For example:

$ pulumi import aws:redshift/hsmClientCertificate:HsmClientCertificate test example
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws