@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
79 lines • 2.29 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Retrieve the ancestors for a project.
* See the [REST API](https://docs.cloud.google.com/resource-manager/reference/rest/v1/projects/getAncestry) for more details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.projects.getAncestry({
* project: "example-project",
* });
* ```
*/
export declare function getAncestry(args?: GetAncestryArgs, opts?: pulumi.InvokeOptions): Promise<GetAncestryResult>;
/**
* A collection of arguments for invoking getAncestry.
*/
export interface GetAncestryArgs {
/**
* The ID of the project. If it is not provided, the provider project is used.
*/
project?: string;
}
/**
* A collection of values returned by getAncestry.
*/
export interface GetAncestryResult {
/**
* A list of the project's ancestors. Structure is defined below.
*/
readonly ancestors: outputs.projects.GetAncestryAncestor[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The organization id.
*/
readonly orgId: string;
/**
* The parent's id.
*/
readonly parentId: string;
/**
* One of `"folder"` or `"organization"`.
*/
readonly parentType: string;
readonly project?: string;
}
/**
* Retrieve the ancestors for a project.
* See the [REST API](https://docs.cloud.google.com/resource-manager/reference/rest/v1/projects/getAncestry) for more details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.projects.getAncestry({
* project: "example-project",
* });
* ```
*/
export declare function getAncestryOutput(args?: GetAncestryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAncestryResult>;
/**
* A collection of arguments for invoking getAncestry.
*/
export interface GetAncestryOutputArgs {
/**
* The ID of the project. If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getAncestry.d.ts.map