UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

217 lines • 9.77 kB
"use strict"; // *** WARNING: this file was generated by pulumi-language-nodejs. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.RegionalParameterVersion = void 0; const pulumi = __importStar(require("@pulumi/pulumi")); const utilities = __importStar(require("../utilities")); /** * A Regional Parameter Version resource that stores the actual value of the regional parameter. * * To get more information about RegionalParameterVersion, see: * * * [API documentation](https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters.versions) * * ## Example Usage * * ### Regional Parameter Version Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const regional_parameter_basic = new gcp.parametermanager.RegionalParameter("regional-parameter-basic", { * parameterId: "regional_parameter", * location: "us-central1", * }); * const regional_parameter_version_basic = new gcp.parametermanager.RegionalParameterVersion("regional-parameter-version-basic", { * parameter: regional_parameter_basic.id, * parameterVersionId: "regional_parameter_version", * parameterData: "regional-parameter-version-data", * }); * ``` * ### Regional Parameter Version With Json Format * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const regional_parameter_basic = new gcp.parametermanager.RegionalParameter("regional-parameter-basic", { * parameterId: "regional_parameter", * format: "JSON", * location: "us-central1", * }); * const regional_parameter_version_with_json_format = new gcp.parametermanager.RegionalParameterVersion("regional-parameter-version-with-json-format", { * parameter: regional_parameter_basic.id, * parameterVersionId: "regional_parameter_version", * parameterData: JSON.stringify({ * key1: "val1", * key2: "val2", * }), * }); * ``` * ### Regional Parameter Version With Kms Key * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const project = gcp.organizations.getProject({}); * const regional_parameter_basic = new gcp.parametermanager.RegionalParameter("regional-parameter-basic", { * parameterId: "regional_parameter", * location: "us-central1", * kmsKey: "kms-key", * }); * const regional_parameter_version_with_kms_key = new gcp.parametermanager.RegionalParameterVersion("regional-parameter-version-with-kms-key", { * parameter: regional_parameter_basic.id, * parameterVersionId: "regional_parameter_version", * parameterData: "regional-parameter-version-data", * }); * ``` * ### Regional Parameter Version With Json Format With File * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as std from "@pulumi/std"; * * const regional_parameter_basic = new gcp.parametermanager.RegionalParameter("regional-parameter-basic", { * parameterId: "regional_parameter", * format: "JSON", * location: "us-central1", * }); * const regional_parameter_version_with_json_format_with_file = new gcp.parametermanager.RegionalParameterVersion("regional-parameter-version-with-json-format-with-file", { * parameter: regional_parameter_basic.id, * parameterVersionId: "regional_parameter_version", * parameterData: std.file({ * input: "regional-parameter-json-data.json", * }).then(invoke => invoke.result), * }); * ``` * ### Regional Parameter Version With Yaml Format With File * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as std from "@pulumi/std"; * * const regional_parameter_basic = new gcp.parametermanager.RegionalParameter("regional-parameter-basic", { * parameterId: "regional_parameter", * format: "YAML", * location: "us-central1", * }); * const regional_parameter_version_with_yaml_format_with_file = new gcp.parametermanager.RegionalParameterVersion("regional-parameter-version-with-yaml-format-with-file", { * parameter: regional_parameter_basic.id, * parameterVersionId: "regional_parameter_version", * parameterData: std.file({ * input: "regional-parameter-yaml-data.yaml", * }).then(invoke => invoke.result), * }); * ``` * * ## Import * * RegionalParameterVersion can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}}` * * When using the `pulumi import` command, RegionalParameterVersion can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:parametermanager/regionalParameterVersion:RegionalParameterVersion default projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}} * ``` */ class RegionalParameterVersion extends pulumi.CustomResource { /** * Get an existing RegionalParameterVersion 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 RegionalParameterVersion(name, state, { ...opts, id: id }); } /** @internal */ static __pulumiType = 'gcp:parametermanager/regionalParameterVersion:RegionalParameterVersion'; /** * Returns true if the given object is an instance of RegionalParameterVersion. 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'] === RegionalParameterVersion.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["createTime"] = state?.createTime; resourceInputs["deletionPolicy"] = state?.deletionPolicy; resourceInputs["disabled"] = state?.disabled; resourceInputs["kmsKeyVersion"] = state?.kmsKeyVersion; resourceInputs["location"] = state?.location; resourceInputs["name"] = state?.name; resourceInputs["parameter"] = state?.parameter; resourceInputs["parameterData"] = state?.parameterData; resourceInputs["parameterVersionId"] = state?.parameterVersionId; resourceInputs["updateTime"] = state?.updateTime; } else { const args = argsOrState; if (args?.parameter === undefined && !opts.urn) { throw new Error("Missing required property 'parameter'"); } if (args?.parameterData === undefined && !opts.urn) { throw new Error("Missing required property 'parameterData'"); } if (args?.parameterVersionId === undefined && !opts.urn) { throw new Error("Missing required property 'parameterVersionId'"); } resourceInputs["deletionPolicy"] = args?.deletionPolicy; resourceInputs["disabled"] = args?.disabled; resourceInputs["parameter"] = args?.parameter; resourceInputs["parameterData"] = args?.parameterData ? pulumi.secret(args.parameterData) : undefined; resourceInputs["parameterVersionId"] = args?.parameterVersionId; resourceInputs["createTime"] = undefined /*out*/; resourceInputs["kmsKeyVersion"] = undefined /*out*/; resourceInputs["location"] = undefined /*out*/; resourceInputs["name"] = undefined /*out*/; resourceInputs["updateTime"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); const secretOpts = { additionalSecretOutputs: ["parameterData"] }; opts = pulumi.mergeOptions(opts, secretOpts); super(RegionalParameterVersion.__pulumiType, name, resourceInputs, opts); } } exports.RegionalParameterVersion = RegionalParameterVersion; //# sourceMappingURL=regionalParameterVersion.js.map