@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
220 lines (219 loc) • 8.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A resource that represents an asset group. The purpose of an asset group is to bundle a set of assets that have something in common, while allowing users to add annotations to the group.
*
* ## Example Usage
*
* ### Migration Group Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.migrationcenter.Group("default", {
* location: "us-central1",
* groupId: "group-test",
* description: "Terraform integration test description",
* displayName: "Terraform integration test display",
* labels: {
* key: "value",
* },
* });
* ```
*
* ## Import
*
* Group can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/groups/{{group_id}}`
*
* * `{{project}}/{{location}}/{{group_id}}`
*
* * `{{location}}/{{group_id}}`
*
* When using the `pulumi import` command, Group can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:migrationcenter/group:Group default projects/{{project}}/locations/{{location}}/groups/{{group_id}}
* ```
*
* ```sh
* $ pulumi import gcp:migrationcenter/group:Group default {{project}}/{{location}}/{{group_id}}
* ```
*
* ```sh
* $ pulumi import gcp:migrationcenter/group:Group default {{location}}/{{group_id}}
* ```
*/
export declare class Group extends pulumi.CustomResource {
/**
* Get an existing Group 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?: GroupState, opts?: pulumi.CustomResourceOptions): Group;
/**
* Returns true if the given object is an instance of Group. 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 Group;
/**
* Output only. The timestamp when the group was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Optional. The description of the group.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Optional. User-friendly display name.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* 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;
}>;
/**
* Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: `a-z?`.
*/
readonly groupId: pulumi.Output<string>;
/**
* Labels as key value pairs.
* **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 group.
*/
readonly location: pulumi.Output<string>;
/**
* Output only. The name of the group.
*/
readonly name: 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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Output only. The timestamp when the group was last updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Group 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: GroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Group resources.
*/
export interface GroupState {
/**
* Output only. The timestamp when the group was created.
*/
createTime?: pulumi.Input<string>;
/**
* Optional. The description of the group.
*/
description?: pulumi.Input<string>;
/**
* Optional. User-friendly display name.
*/
displayName?: 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>;
}>;
/**
* Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: `a-z?`.
*/
groupId?: pulumi.Input<string>;
/**
* Labels as key value pairs.
* **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 group.
*/
location?: pulumi.Input<string>;
/**
* Output only. The name of the group.
*/
name?: 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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Output only. The timestamp when the group was last updated.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Group resource.
*/
export interface GroupArgs {
/**
* Optional. The description of the group.
*/
description?: pulumi.Input<string>;
/**
* Optional. User-friendly display name.
*/
displayName?: pulumi.Input<string>;
/**
* Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: `a-z?`.
*/
groupId: pulumi.Input<string>;
/**
* Labels as key value pairs.
* **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 group.
*/
location: 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>;
}