@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
88 lines • 3.64 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Alias = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides an alias for a KMS customer master key. AWS Console enforces 1-to-1 mapping between aliases & keys,
* but API (hence this provider too) allows you to create as many aliases as
* the [account limits](http://docs.aws.amazon.com/kms/latest/developerguide/limits.html) allow you.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const a = new aws.kms.Key("a", {});
* const aAlias = new aws.kms.Alias("a", {
* name: "alias/my-key-alias",
* targetKeyId: a.keyId,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import KMS aliases using the `name`. For example:
*
* ```sh
* $ pulumi import aws:kms/alias:Alias a alias/my-key-alias
* ```
*/
class Alias extends pulumi.CustomResource {
/**
* Get an existing Alias 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, id, state, opts) {
return new Alias(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of Alias. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Alias.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["arn"] = state ? state.arn : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["namePrefix"] = state ? state.namePrefix : undefined;
resourceInputs["region"] = state ? state.region : undefined;
resourceInputs["targetKeyArn"] = state ? state.targetKeyArn : undefined;
resourceInputs["targetKeyId"] = state ? state.targetKeyId : undefined;
}
else {
const args = argsOrState;
if ((!args || args.targetKeyId === undefined) && !opts.urn) {
throw new Error("Missing required property 'targetKeyId'");
}
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["namePrefix"] = args ? args.namePrefix : undefined;
resourceInputs["region"] = args ? args.region : undefined;
resourceInputs["targetKeyId"] = args ? args.targetKeyId : undefined;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["targetKeyArn"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Alias.__pulumiType, name, resourceInputs, opts);
}
}
exports.Alias = Alias;
/** @internal */
Alias.__pulumiType = 'aws:kms/alias:Alias';
//# sourceMappingURL=alias.js.map