@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
217 lines • 9.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a RuntimeConfig variable in Google Cloud. For more information, see the
* [official documentation](https://cloud.google.com/deployment-manager/runtime-configurator/),
* or the
* [JSON API](https://cloud.google.com/deployment-manager/runtime-configurator/reference/rest/).
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* ## Example Usage
*
* Example creating a RuntimeConfig variable.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_runtime_config = new gcp.runtimeconfig.Config("my-runtime-config", {
* name: "my-service-runtime-config",
* description: "Runtime configuration values for my service",
* });
* const environment = new gcp.runtimeconfig.Variable("environment", {
* parent: my_runtime_config.name,
* name: "prod-variables/hostname",
* text: "example.com",
* });
* ```
*
* You can also encode binary content using the `value` argument instead. The
* value must be base64 encoded.
*
* Example of using the `value` argument.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as std from "@pulumi/std";
*
* const my_runtime_config = new gcp.runtimeconfig.Config("my-runtime-config", {
* name: "my-service-runtime-config",
* description: "Runtime configuration values for my service",
* });
* const my_secret = new gcp.runtimeconfig.Variable("my-secret", {
* parent: my_runtime_config.name,
* name: "secret",
* value: std.filebase64({
* input: "my-encrypted-secret.dat",
* }).then(invoke => invoke.result),
* });
* ```
*
* ## Import
*
* Runtime Config Variables can be imported using the `name` or full variable name, e.g.
*
* * `projects/my-gcp-project/configs/{{config_id}}/variables/{{name}}`
* * `{{config_id}}/{{name}}`
*
* When using the `pulumi import` command, Runtime Config Variables can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:runtimeconfig/variable:Variable default projects/my-gcp-project/configs/{{config_id}}/variables/{{name}}
* $ pulumi import gcp:runtimeconfig/variable:Variable default {{config_id}}/{{name}}
* ```
* When importing using only the name, the provider project must be set.
*/
export declare class Variable extends pulumi.CustomResource {
/**
* Get an existing Variable 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?: VariableState, opts?: pulumi.CustomResourceOptions): Variable;
/**
* Returns true if the given object is an instance of Variable. 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 Variable;
/**
* 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 name of the variable to manage. Note that variable
* names can be hierarchical using slashes (e.g. "prod-variables/hostname").
*/
readonly name: pulumi.Output<string>;
/**
* The name of the RuntimeConfig resource containing this
* variable.
*/
readonly parent: pulumi.Output<string>;
/**
* 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>;
/**
* or `value` - (Required) The content to associate with the variable.
* Exactly one of `text` or `variable` must be specified. If `text` is specified,
* it must be a valid UTF-8 string and less than 4096 bytes in length. If `value`
* is specified, it must be base64 encoded and less than 4096 bytes in length.
*
* - - -
*/
readonly text: pulumi.Output<string | undefined>;
/**
* (Computed) The timestamp in RFC3339 UTC "Zulu" format,
* accurate to nanoseconds, representing when the variable was last updated.
* Example: "2016-10-09T12:33:37.578138407Z".
*/
readonly updateTime: pulumi.Output<string>;
readonly value: pulumi.Output<string | undefined>;
/**
* Create a Variable 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: VariableArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Variable resources.
*/
export interface VariableState {
/**
* 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 name of the variable to manage. Note that variable
* names can be hierarchical using slashes (e.g. "prod-variables/hostname").
*/
name?: pulumi.Input<string | undefined>;
/**
* The name of the RuntimeConfig resource containing this
* variable.
*/
parent?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* or `value` - (Required) The content to associate with the variable.
* Exactly one of `text` or `variable` must be specified. If `text` is specified,
* it must be a valid UTF-8 string and less than 4096 bytes in length. If `value`
* is specified, it must be base64 encoded and less than 4096 bytes in length.
*
* - - -
*/
text?: pulumi.Input<string | undefined>;
/**
* (Computed) The timestamp in RFC3339 UTC "Zulu" format,
* accurate to nanoseconds, representing when the variable was last updated.
* Example: "2016-10-09T12:33:37.578138407Z".
*/
updateTime?: pulumi.Input<string | undefined>;
value?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Variable resource.
*/
export interface VariableArgs {
/**
* 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 name of the variable to manage. Note that variable
* names can be hierarchical using slashes (e.g. "prod-variables/hostname").
*/
name?: pulumi.Input<string | undefined>;
/**
* The name of the RuntimeConfig resource containing this
* variable.
*/
parent: 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 | undefined>;
/**
* or `value` - (Required) The content to associate with the variable.
* Exactly one of `text` or `variable` must be specified. If `text` is specified,
* it must be a valid UTF-8 string and less than 4096 bytes in length. If `value`
* is specified, it must be base64 encoded and less than 4096 bytes in length.
*
* - - -
*/
text?: pulumi.Input<string | undefined>;
value?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=variable.d.ts.map