@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
309 lines (308 loc) • 12.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A Regional Parameter is a logical regional parameter.
*
* To get more information about RegionalParameter, see:
*
* * [API documentation](https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters)
*
* ## Example Usage
*
* ### Regional Parameter 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",
* });
* ```
* ### Regional Parameter With Format
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const regional_parameter_with_format = new gcp.parametermanager.RegionalParameter("regional-parameter-with-format", {
* parameterId: "regional_parameter",
* location: "us-central1",
* format: "JSON",
* });
* ```
* ### Regional Parameter With Labels
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const regional_parameter_with_labels = new gcp.parametermanager.RegionalParameter("regional-parameter-with-labels", {
* parameterId: "regional_parameter",
* location: "us-central1",
* labels: {
* key1: "val1",
* key2: "val2",
* key3: "val3",
* key4: "val4",
* key5: "val5",
* },
* });
* ```
* ### Regional Parameter With Kms Key
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const regional_parameter_with_kms_key = new gcp.parametermanager.RegionalParameter("regional-parameter-with-kms-key", {
* parameterId: "regional_parameter",
* location: "us-central1",
* kmsKey: "kms-key",
* });
* ```
*
* ## Import
*
* RegionalParameter can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}`
*
* * `{{project}}/{{location}}/{{parameter_id}}`
*
* * `{{location}}/{{parameter_id}}`
*
* When using the `pulumi import` command, RegionalParameter can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:parametermanager/regionalParameter:RegionalParameter default projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}
* ```
*
* ```sh
* $ pulumi import gcp:parametermanager/regionalParameter:RegionalParameter default {{project}}/{{location}}/{{parameter_id}}
* ```
*
* ```sh
* $ pulumi import gcp:parametermanager/regionalParameter:RegionalParameter default {{location}}/{{parameter_id}}
* ```
*/
export declare class RegionalParameter extends pulumi.CustomResource {
/**
* Get an existing RegionalParameter 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?: RegionalParameterState, opts?: pulumi.CustomResourceOptions): RegionalParameter;
/**
* Returns true if the given object is an instance of RegionalParameter. 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 RegionalParameter;
/**
* The time at which the regional Parameter was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The format type of the regional parameter.
* Default value is `UNFORMATTED`.
* Possible values are: `UNFORMATTED`, `YAML`, `JSON`.
*/
readonly format: pulumi.Output<string | undefined>;
/**
* The resource name of the Cloud KMS CryptoKey used to encrypt regional parameter version payload. Format
* `projects/{{project}}/locations/{{location}}/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}`
*/
readonly kmsKey: pulumi.Output<string | undefined>;
/**
* The labels assigned to this regional Parameter.
* Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes,
* and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
* Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes,
* and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
* No more than 64 labels can be assigned to a given resource.
* An object containing a list of "key": value pairs. Example:
* { "name": "wrench", "mass": "1.3kg", "count": "3" }.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The location of the regional parameter. eg us-central1
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of the regional Parameter. Format:
* `projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}`
*/
readonly name: pulumi.Output<string>;
/**
* This must be unique within the project.
*/
readonly parameterId: pulumi.Output<string>;
/**
* An object containing a unique resource identity tied to the regional parameter.
* Structure is documented below.
*/
readonly policyMembers: pulumi.Output<outputs.parametermanager.RegionalParameterPolicyMember[]>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The time at which the regional Parameter was updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a RegionalParameter 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: RegionalParameterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RegionalParameter resources.
*/
export interface RegionalParameterState {
/**
* The time at which the regional Parameter was created.
*/
createTime?: pulumi.Input<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The format type of the regional parameter.
* Default value is `UNFORMATTED`.
* Possible values are: `UNFORMATTED`, `YAML`, `JSON`.
*/
format?: pulumi.Input<string>;
/**
* The resource name of the Cloud KMS CryptoKey used to encrypt regional parameter version payload. Format
* `projects/{{project}}/locations/{{location}}/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}`
*/
kmsKey?: pulumi.Input<string>;
/**
* The labels assigned to this regional Parameter.
* Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes,
* and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
* Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes,
* and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
* No more than 64 labels can be assigned to a given resource.
* An object containing a list of "key": value pairs. Example:
* { "name": "wrench", "mass": "1.3kg", "count": "3" }.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The location of the regional parameter. eg us-central1
*/
location?: pulumi.Input<string>;
/**
* The resource name of the regional Parameter. Format:
* `projects/{{project}}/locations/{{location}}/parameters/{{parameter_id}}`
*/
name?: pulumi.Input<string>;
/**
* This must be unique within the project.
*/
parameterId?: pulumi.Input<string>;
/**
* An object containing a unique resource identity tied to the regional parameter.
* Structure is documented below.
*/
policyMembers?: pulumi.Input<pulumi.Input<inputs.parametermanager.RegionalParameterPolicyMember>[]>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The time at which the regional Parameter was updated.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RegionalParameter resource.
*/
export interface RegionalParameterArgs {
/**
* The format type of the regional parameter.
* Default value is `UNFORMATTED`.
* Possible values are: `UNFORMATTED`, `YAML`, `JSON`.
*/
format?: pulumi.Input<string>;
/**
* The resource name of the Cloud KMS CryptoKey used to encrypt regional parameter version payload. Format
* `projects/{{project}}/locations/{{location}}/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}`
*/
kmsKey?: pulumi.Input<string>;
/**
* The labels assigned to this regional Parameter.
* Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes,
* and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
* Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes,
* and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
* No more than 64 labels can be assigned to a given resource.
* An object containing a list of "key": value pairs. Example:
* { "name": "wrench", "mass": "1.3kg", "count": "3" }.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The location of the regional parameter. eg us-central1
*/
location: pulumi.Input<string>;
/**
* This must be unique within the project.
*/
parameterId: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}