@pulumi/gcp/parametermanager/regionalParameterVersion.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * 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}}
 * ```
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: RegionalParameterVersionState, opts?: pulumi.CustomResourceOptions): 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: any): obj is RegionalParameterVersion;
    /**
     * The time at which the Regional Parameter Version was created.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * The current state of Regional Parameter Version. This field is only applicable for updating Regional Parameter Version.
     */
    readonly disabled: pulumi.Output<boolean | undefined>;
    /**
     * The resource name of the Cloud KMS CryptoKeyVersion used to decrypt regional parameter version payload. Format
     * `projects/{{project}}/locations/{{location}}/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}/cryptoKeyVersions/{{crypto_key_version}}`
     */
    readonly kmsKeyVersion: pulumi.Output<string>;
    /**
     * Location of Parameter Manager Regional parameter resource.
     */
    readonly location: pulumi.Output<string>;
    /**
     * The resource name of the Regional Parameter Version. Format:
     * `projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}}`
     */
    readonly name: pulumi.Output<string>;
    /**
     * Parameter Manager Regional Parameter resource.
     */
    readonly parameter: pulumi.Output<string>;
    /**
     * The Regional Parameter data.
     * **Note**: This property is sensitive and will not be displayed in the plan.
     */
    readonly parameterData: pulumi.Output<string>;
    /**
     * Version ID of the Regional Parameter Version Resource. This must be unique within the Regional Parameter.
     */
    readonly parameterVersionId: pulumi.Output<string>;
    /**
     * The time at which the Regional Parameter Version was updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a RegionalParameterVersion 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: RegionalParameterVersionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering RegionalParameterVersion resources.
 */
export interface RegionalParameterVersionState {
    /**
     * The time at which the Regional Parameter Version was created.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * The current state of Regional Parameter Version. This field is only applicable for updating Regional Parameter Version.
     */
    disabled?: pulumi.Input<boolean | undefined>;
    /**
     * The resource name of the Cloud KMS CryptoKeyVersion used to decrypt regional parameter version payload. Format
     * `projects/{{project}}/locations/{{location}}/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}/cryptoKeyVersions/{{crypto_key_version}}`
     */
    kmsKeyVersion?: pulumi.Input<string | undefined>;
    /**
     * Location of Parameter Manager Regional parameter resource.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The resource name of the Regional Parameter Version. Format:
     * `projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}/versions/{{parameter_version_id}}`
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Parameter Manager Regional Parameter resource.
     */
    parameter?: pulumi.Input<string | undefined>;
    /**
     * The Regional Parameter data.
     * **Note**: This property is sensitive and will not be displayed in the plan.
     */
    parameterData?: pulumi.Input<string | undefined>;
    /**
     * Version ID of the Regional Parameter Version Resource. This must be unique within the Regional Parameter.
     */
    parameterVersionId?: pulumi.Input<string | undefined>;
    /**
     * The time at which the Regional Parameter Version was updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a RegionalParameterVersion resource.
 */
export interface RegionalParameterVersionArgs {
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * The current state of Regional Parameter Version. This field is only applicable for updating Regional Parameter Version.
     */
    disabled?: pulumi.Input<boolean | undefined>;
    /**
     * Parameter Manager Regional Parameter resource.
     */
    parameter: pulumi.Input<string>;
    /**
     * The Regional Parameter data.
     * **Note**: This property is sensitive and will not be displayed in the plan.
     */
    parameterData: pulumi.Input<string>;
    /**
     * Version ID of the Regional Parameter Version Resource. This must be unique within the Regional Parameter.
     */
    parameterVersionId: pulumi.Input<string>;
}
//# sourceMappingURL=regionalParameterVersion.d.ts.map