@pulumi/vault
Version:
A Pulumi package for creating and managing HashiCorp Vault cloud resources.
107 lines • 3.92 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.Secret = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Writes a KV-V1 secret to a given path in Vault.
*
* For more information on Vault's KV-V1 secret backend
* [see here](https://www.vaultproject.io/docs/secrets/kv/kv-v1).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
*
* const kvv1 = new vault.Mount("kvv1", {
* path: "kvv1",
* type: "kv",
* options: {
* version: "1",
* },
* description: "KV Version 1 secret engine mount",
* });
* const secret = new vault.kv.Secret("secret", {
* path: pulumi.interpolate`${kvv1.path}/secret`,
* dataJson: JSON.stringify({
* zip: "zap",
* foo: "bar",
* }),
* });
* ```
*
* ## Required Vault Capabilities
*
* Use of this resource requires the `create` or `update` capability
* (depending on whether the resource already exists) on the given path,
* the `delete` capability if the resource is removed from configuration,
* and the `read` capability for drift detection (by default).
*
* ## Import
*
* KV-V1 secrets can be imported using the `path`, e.g.
*
* ```sh
* $ pulumi import vault:kv/secret:Secret secret kvv1/secret
* ```
*/
class Secret extends pulumi.CustomResource {
/**
* Get an existing Secret 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 Secret(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Secret. 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'] === Secret.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["data"] = state?.data;
resourceInputs["dataJson"] = state?.dataJson;
resourceInputs["namespace"] = state?.namespace;
resourceInputs["path"] = state?.path;
}
else {
const args = argsOrState;
if (args?.dataJson === undefined && !opts.urn) {
throw new Error("Missing required property 'dataJson'");
}
if (args?.path === undefined && !opts.urn) {
throw new Error("Missing required property 'path'");
}
resourceInputs["dataJson"] = args?.dataJson ? pulumi.secret(args.dataJson) : undefined;
resourceInputs["namespace"] = args?.namespace;
resourceInputs["path"] = args?.path;
resourceInputs["data"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["data", "dataJson"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(Secret.__pulumiType, name, resourceInputs, opts);
}
}
exports.Secret = Secret;
/** @internal */
Secret.__pulumiType = 'vault:kv/secret:Secret';
//# sourceMappingURL=secret.js.map