@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
127 lines (126 loc) • 5.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.redshift.HsmClientCertificate("example", {hsmClientCertificateIdentifier: "example"});
* ```
*
* ## Import
*
* Using `pulumi import`, import Redshift HSM Client Certificates using `hsm_client_certificate_identifier`. For example:
*
* ```sh
* $ pulumi import aws:redshift/hsmClientCertificate:HsmClientCertificate test example
* ```
*/
export declare class HsmClientCertificate extends pulumi.CustomResource {
/**
* Get an existing HsmClientCertificate resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HsmClientCertificateState, opts?: pulumi.CustomResourceOptions): HsmClientCertificate;
/**
* Returns true if the given object is an instance of HsmClientCertificate. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is HsmClientCertificate;
/**
* Amazon Resource Name (ARN) of the Hsm Client Certificate.
*/
readonly arn: pulumi.Output<string>;
/**
* The identifier of the HSM client certificate.
*/
readonly hsmClientCertificateIdentifier: pulumi.Output<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.
*/
readonly hsmClientCertificatePublicKey: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a HsmClientCertificate resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: HsmClientCertificateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering HsmClientCertificate resources.
*/
export interface HsmClientCertificateState {
/**
* Amazon Resource Name (ARN) of the Hsm Client Certificate.
*/
arn?: pulumi.Input<string>;
/**
* The identifier of the HSM client certificate.
*/
hsmClientCertificateIdentifier?: pulumi.Input<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.
*/
hsmClientCertificatePublicKey?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a HsmClientCertificate resource.
*/
export interface HsmClientCertificateArgs {
/**
* The identifier of the HSM client certificate.
*/
hsmClientCertificateIdentifier: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}