@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
103 lines (102 loc) • 3.41 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to get information about a Google Cloud Folder.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myFolder1 = gcp.organizations.getFolder({
* folder: "folders/12345",
* lookupOrganization: true,
* });
* const myFolder2 = gcp.organizations.getFolder({
* folder: "folders/23456",
* });
* export const myFolder1Organization = myFolder1.then(myFolder1 => myFolder1.organization);
* export const myFolder2Parent = myFolder2.then(myFolder2 => myFolder2.parent);
* ```
*/
export declare function getFolder(args: GetFolderArgs, opts?: pulumi.InvokeOptions): Promise<GetFolderResult>;
/**
* A collection of arguments for invoking getFolder.
*/
export interface GetFolderArgs {
/**
* The name of the Folder in the form `{folder_id}` or `folders/{folder_id}`.
*/
folder: string;
/**
* `true` to find the organization that the folder belongs, `false` to avoid the lookup. It searches up the tree. (defaults to `false`)
*/
lookupOrganization?: boolean;
}
/**
* A collection of values returned by getFolder.
*/
export interface GetFolderResult {
/**
* Timestamp when the Organization was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
*/
readonly createTime: string;
readonly deletionProtection: boolean;
/**
* The folder's display name.
*/
readonly displayName: string;
readonly folder: string;
readonly folderId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The Folder's current lifecycle state.
*/
readonly lifecycleState: string;
readonly lookupOrganization?: boolean;
/**
* The resource name of the Folder in the form `folders/{folder_id}`.
*/
readonly name: string;
/**
* If `lookupOrganization` is enable, the resource name of the Organization that the folder belongs.
*/
readonly organization: string;
/**
* The resource name of the parent Folder or Organization.
*/
readonly parent: string;
}
/**
* Use this data source to get information about a Google Cloud Folder.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myFolder1 = gcp.organizations.getFolder({
* folder: "folders/12345",
* lookupOrganization: true,
* });
* const myFolder2 = gcp.organizations.getFolder({
* folder: "folders/23456",
* });
* export const myFolder1Organization = myFolder1.then(myFolder1 => myFolder1.organization);
* export const myFolder2Parent = myFolder2.then(myFolder2 => myFolder2.parent);
* ```
*/
export declare function getFolderOutput(args: GetFolderOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetFolderResult>;
/**
* A collection of arguments for invoking getFolder.
*/
export interface GetFolderOutputArgs {
/**
* The name of the Folder in the form `{folder_id}` or `folders/{folder_id}`.
*/
folder: pulumi.Input<string>;
/**
* `true` to find the organization that the folder belongs, `false` to avoid the lookup. It searches up the tree. (defaults to `false`)
*/
lookupOrganization?: pulumi.Input<boolean>;
}