@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
233 lines (232 loc) • 9.02 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A Parameter Version resource that stores the actual value of the parameter.
*
* To get more information about ParameterVersion, see:
*
* * [API documentation](https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters.versions)
*
* ## Example Usage
*
* ### Parameter Version Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const parameter_basic = new gcp.parametermanager.Parameter("parameter-basic", {parameterId: "parameter"});
* const parameter_version_basic = new gcp.parametermanager.ParameterVersion("parameter-version-basic", {
* parameter: parameter_basic.id,
* parameterVersionId: "parameter_version",
* parameterData: "app-parameter-version-data",
* });
* ```
* ### Parameter Version With Json Format
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const parameter_basic = new gcp.parametermanager.Parameter("parameter-basic", {
* parameterId: "parameter",
* format: "JSON",
* });
* const parameter_version_with_json_format = new gcp.parametermanager.ParameterVersion("parameter-version-with-json-format", {
* parameter: parameter_basic.id,
* parameterVersionId: "parameter_version",
* parameterData: JSON.stringify({
* key1: "val1",
* key2: "val2",
* }),
* });
* ```
* ### Parameter Version With Kms Key
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const parameter_basic = new gcp.parametermanager.Parameter("parameter-basic", {
* parameterId: "parameter",
* kmsKey: "kms-key",
* });
* const parameter_version_with_kms_key = new gcp.parametermanager.ParameterVersion("parameter-version-with-kms-key", {
* parameter: parameter_basic.id,
* parameterVersionId: "parameter_version",
* parameterData: "app-parameter-version-data",
* });
* ```
* ### 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 parameter_basic = new gcp.parametermanager.Parameter("parameter-basic", {
* parameterId: "parameter",
* format: "JSON",
* });
* const parameter_version_with_json_format_with_file = new gcp.parametermanager.ParameterVersion("parameter-version-with-json-format-with-file", {
* parameter: parameter_basic.id,
* parameterVersionId: "parameter_version",
* parameterData: std.file({
* input: "parameter-json-data.json",
* }).then(invoke => invoke.result),
* });
* ```
* ### 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 parameter_basic = new gcp.parametermanager.Parameter("parameter-basic", {
* parameterId: "parameter",
* format: "YAML",
* });
* const parameter_version_with_yaml_format_with_file = new gcp.parametermanager.ParameterVersion("parameter-version-with-yaml-format-with-file", {
* parameter: parameter_basic.id,
* parameterVersionId: "parameter_version",
* parameterData: std.file({
* input: "parameter-yaml-data.yaml",
* }).then(invoke => invoke.result),
* });
* ```
*
* ## Import
*
* ParameterVersion can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/global/parameters/{{parameter_id}}/versions/{{parameter_version_id}}`
*
* When using the `pulumi import` command, ParameterVersion can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:parametermanager/parameterVersion:ParameterVersion default projects/{{project}}/locations/global/parameters/{{parameter_id}}/versions/{{parameter_version_id}}
* ```
*/
export declare class ParameterVersion extends pulumi.CustomResource {
/**
* Get an existing ParameterVersion 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?: ParameterVersionState, opts?: pulumi.CustomResourceOptions): ParameterVersion;
/**
* Returns true if the given object is an instance of ParameterVersion. 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 ParameterVersion;
/**
* The time at which the Parameter Version was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* The current state of Parameter Version. This field is only applicable for updating Parameter Version.
*/
readonly disabled: pulumi.Output<boolean | undefined>;
/**
* The resource name of the Cloud KMS CryptoKeyVersion used to decrypt parameter version payload. Format
* `projects/{{project}}/locations/global/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}/cryptoKeyVersions/{{crypto_key_version}}`
*/
readonly kmsKeyVersion: pulumi.Output<string>;
/**
* The resource name of the Parameter Version. Format:
* `projects/{{project}}/locations/global/parameters/{{parameter_id}}/versions/{{parameter_version_id}}`
*/
readonly name: pulumi.Output<string>;
/**
* Parameter Manager Parameter resource.
*/
readonly parameter: pulumi.Output<string>;
/**
* The Parameter data.
* **Note**: This property is sensitive and will not be displayed in the plan.
*/
readonly parameterData: pulumi.Output<string>;
/**
* Version ID of the Parameter Version Resource. This must be unique within the Parameter.
*/
readonly parameterVersionId: pulumi.Output<string>;
/**
* The time at which the Parameter Version was updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a ParameterVersion 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: ParameterVersionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ParameterVersion resources.
*/
export interface ParameterVersionState {
/**
* The time at which the Parameter Version was created.
*/
createTime?: pulumi.Input<string>;
/**
* The current state of Parameter Version. This field is only applicable for updating Parameter Version.
*/
disabled?: pulumi.Input<boolean>;
/**
* The resource name of the Cloud KMS CryptoKeyVersion used to decrypt parameter version payload. Format
* `projects/{{project}}/locations/global/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}/cryptoKeyVersions/{{crypto_key_version}}`
*/
kmsKeyVersion?: pulumi.Input<string>;
/**
* The resource name of the Parameter Version. Format:
* `projects/{{project}}/locations/global/parameters/{{parameter_id}}/versions/{{parameter_version_id}}`
*/
name?: pulumi.Input<string>;
/**
* Parameter Manager Parameter resource.
*/
parameter?: pulumi.Input<string>;
/**
* The Parameter data.
* **Note**: This property is sensitive and will not be displayed in the plan.
*/
parameterData?: pulumi.Input<string>;
/**
* Version ID of the Parameter Version Resource. This must be unique within the Parameter.
*/
parameterVersionId?: pulumi.Input<string>;
/**
* The time at which the Parameter Version was updated.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ParameterVersion resource.
*/
export interface ParameterVersionArgs {
/**
* The current state of Parameter Version. This field is only applicable for updating Parameter Version.
*/
disabled?: pulumi.Input<boolean>;
/**
* Parameter Manager Parameter resource.
*/
parameter: pulumi.Input<string>;
/**
* The Parameter data.
* **Note**: This property is sensitive and will not be displayed in the plan.
*/
parameterData: pulumi.Input<string>;
/**
* Version ID of the Parameter Version Resource. This must be unique within the Parameter.
*/
parameterVersionId: pulumi.Input<string>;
}