@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
108 lines (107 loc) • 3.19 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Get a tag key by org or project `parent` and `shortName`.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const environmentTagKey = gcp.tags.getTagKey({
* parent: "organizations/12345",
* shortName: "environment",
* });
* ```
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const environmentTagKey = gcp.tags.getTagKey({
* parent: "projects/abc",
* shortName: "environment",
* });
* ```
*/
export declare function getTagKey(args: GetTagKeyArgs, opts?: pulumi.InvokeOptions): Promise<GetTagKeyResult>;
/**
* A collection of arguments for invoking getTagKey.
*/
export interface GetTagKeyArgs {
/**
* The resource name of the parent organization or project. It can be in format `organizations/{org_id}` or `projects/{project_id_or_number}`.
*/
parent: string;
/**
* The tag key's short_name.
*/
shortName: string;
}
/**
* A collection of values returned by getTagKey.
*/
export interface GetTagKeyResult {
/**
* 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: string;
readonly description: string;
/**
* an identifier for the resource with format `tagKeys/{{name}}`
*/
readonly id: string;
/**
* The generated numeric id for the TagKey.
*/
readonly name: string;
/**
* Namespaced name of the TagKey which is in the format `{parentNamespace}/{shortName}`.
*/
readonly namespacedName: string;
readonly parent: string;
readonly shortName: string;
/**
* 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: string;
}
/**
* Get a tag key by org or project `parent` and `shortName`.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const environmentTagKey = gcp.tags.getTagKey({
* parent: "organizations/12345",
* shortName: "environment",
* });
* ```
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const environmentTagKey = gcp.tags.getTagKey({
* parent: "projects/abc",
* shortName: "environment",
* });
* ```
*/
export declare function getTagKeyOutput(args: GetTagKeyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTagKeyResult>;
/**
* A collection of arguments for invoking getTagKey.
*/
export interface GetTagKeyOutputArgs {
/**
* The resource name of the parent organization or project. It can be in format `organizations/{org_id}` or `projects/{project_id_or_number}`.
*/
parent: pulumi.Input<string>;
/**
* The tag key's short_name.
*/
shortName: pulumi.Input<string>;
}