@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
162 lines • 6.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A resource represents a Dataform TeamFolder
*
* To get more information about TeamFolder, see:
*
* * [API documentation](https://cloud.google.com/dataform/reference/rest/v1/projects.locations.teamFolders)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/dataform/docs/)
*
* ## Example Usage
*
* ### Dataform Team Folder Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataformTeamFolderBasic = new gcp.dataform.TeamFolder("dataform_team_folder_basic", {
* region: "us-central1",
* displayName: "Basic TeamFolder-_34535",
* });
* ```
*
* ## Import
*
* TeamFolder can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{region}}/teamFolders/{{teamfolder_id}}`
* * `{{project}}/{{region}}/{{teamfolder_id}}`
* * `{{region}}/{{teamfolder_id}}`
* * `{{teamfolder_id}}`
* * `{{name}}`
*
* When using the `pulumi import` command, TeamFolder can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:dataform/teamFolder:TeamFolder default projects/{{project}}/locations/{{region}}/teamFolders/{{teamfolder_id}}
* $ pulumi import gcp:dataform/teamFolder:TeamFolder default {{project}}/{{region}}/{{teamfolder_id}}
* $ pulumi import gcp:dataform/teamFolder:TeamFolder default {{region}}/{{teamfolder_id}}
* $ pulumi import gcp:dataform/teamFolder:TeamFolder default {{teamfolder_id}}
* $ pulumi import gcp:dataform/teamFolder:TeamFolder default {{name}}
* ```
*/
export declare class TeamFolder extends pulumi.CustomResource {
/**
* Get an existing TeamFolder 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?: TeamFolderState, opts?: pulumi.CustomResourceOptions): TeamFolder;
/**
* Returns true if the given object is an instance of TeamFolder. 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 TeamFolder;
/**
* 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>;
/**
* Required. The TeamFolder's user-friendly name.
*/
readonly displayName: pulumi.Output<string>;
/**
* The TeamFolder's name.
*/
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>;
/**
* A reference to the region
*/
readonly region: pulumi.Output<string>;
/**
* The unique identifier for the TeamFolder.
*/
readonly teamfolderId: pulumi.Output<string>;
/**
* Create a TeamFolder 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: TeamFolderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TeamFolder resources.
*/
export interface TeamFolderState {
/**
* 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>;
/**
* Required. The TeamFolder's user-friendly name.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* The TeamFolder's name.
*/
name?: 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>;
/**
* A reference to the region
*/
region?: pulumi.Input<string | undefined>;
/**
* The unique identifier for the TeamFolder.
*/
teamfolderId?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a TeamFolder resource.
*/
export interface TeamFolderArgs {
/**
* 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>;
/**
* Required. The TeamFolder's user-friendly name.
*/
displayName: 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>;
/**
* A reference to the region
*/
region: pulumi.Input<string>;
}
//# sourceMappingURL=teamFolder.d.ts.map