@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
159 lines (158 loc) • 6.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A TagValue is a child of a particular TagKey. TagValues are used to group cloud resources for the purpose of controlling them using policies.
*
* To get more information about TagValue, see:
*
* * [API documentation](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)
*
* ## Example Usage
*
* ### Tag Value Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const key = new gcp.tags.TagKey("key", {
* parent: "organizations/123456789",
* shortName: "keyname",
* description: "For keyname resources.",
* });
* const value = new gcp.tags.TagValue("value", {
* parent: key.id,
* shortName: "valuename",
* description: "For valuename resources.",
* });
* ```
*
* ## Import
*
* TagValue can be imported using any of these accepted formats:
*
* * `tagValues/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, TagValue can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:tags/tagValue:TagValue default tagValues/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:tags/tagValue:TagValue default {{name}}
* ```
*/
export declare class TagValue extends pulumi.CustomResource {
/**
* Get an existing TagValue 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?: TagValueState, opts?: pulumi.CustomResourceOptions): TagValue;
/**
* Returns true if the given object is an instance of TagValue. 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 TagValue;
/**
* Output only. Creation time.
* A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
*/
readonly createTime: pulumi.Output<string>;
/**
* User-assigned description of the TagValue. Must not exceed 256 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The generated numeric id for the TagValue.
*/
readonly name: pulumi.Output<string>;
/**
* Output only. Namespaced name of the TagValue. Will be in the format {parentNamespace}/{tagKeyShortName}/{shortName}.
*/
readonly namespacedName: pulumi.Output<string>;
/**
* Input only. The resource name of the new TagValue's parent. Must be of the form tagKeys/{tag_key_id}.
*/
readonly parent: pulumi.Output<string>;
/**
* Input only. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey.
* The short name can have a maximum length of 256 characters. The permitted character set for the shortName includes all UTF-8 encoded Unicode characters except single quotes ('), double quotes ("), backslashes (\\), and forward slashes (/).
*/
readonly shortName: pulumi.Output<string>;
/**
* Output only. Update time.
* A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a TagValue 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: TagValueArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TagValue resources.
*/
export interface TagValueState {
/**
* Output only. Creation time.
* A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
*/
createTime?: pulumi.Input<string>;
/**
* User-assigned description of the TagValue. Must not exceed 256 characters.
*/
description?: pulumi.Input<string>;
/**
* The generated numeric id for the TagValue.
*/
name?: pulumi.Input<string>;
/**
* Output only. Namespaced name of the TagValue. Will be in the format {parentNamespace}/{tagKeyShortName}/{shortName}.
*/
namespacedName?: pulumi.Input<string>;
/**
* Input only. The resource name of the new TagValue's parent. Must be of the form tagKeys/{tag_key_id}.
*/
parent?: pulumi.Input<string>;
/**
* Input only. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey.
* The short name can have a maximum length of 256 characters. The permitted character set for the shortName includes all UTF-8 encoded Unicode characters except single quotes ('), double quotes ("), backslashes (\\), and forward slashes (/).
*/
shortName?: pulumi.Input<string>;
/**
* Output only. Update time.
* A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TagValue resource.
*/
export interface TagValueArgs {
/**
* User-assigned description of the TagValue. Must not exceed 256 characters.
*/
description?: pulumi.Input<string>;
/**
* Input only. The resource name of the new TagValue's parent. Must be of the form tagKeys/{tag_key_id}.
*/
parent: pulumi.Input<string>;
/**
* Input only. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey.
* The short name can have a maximum length of 256 characters. The permitted character set for the shortName includes all UTF-8 encoded Unicode characters except single quotes ('), double quotes ("), backslashes (\\), and forward slashes (/).
*/
shortName: pulumi.Input<string>;
}