@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
122 lines (121 loc) • 4.26 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A Google Cloud Firebase instance. This enables Firebase resources on a given Google Project.
* Since a FirebaseProject is actually also a GCP Project, a FirebaseProject uses underlying GCP
* identifiers (most importantly, the projectId) as its own for easy interop with GCP APIs.
* Once Firebase has been added to a Google Project it cannot be removed.
*
* To get more information about Project, see:
*
* * [API documentation](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects)
* * How-to Guides
* * Official Documentation
*
* > **Note:** This resource should usually be used with a provider configuration
* with `userProjectOverride = true` unless you wish for your quota
* project to be different from the Firebase project.
*
* ## Example Usage
*
* ### Firebase Project Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.organizations.Project("default", {
* projectId: "my-project",
* name: "my-project",
* orgId: "123456789",
* deletionPolicy: "DELETE",
* labels: {
* firebase: "enabled",
* },
* });
* const defaultProject = new gcp.firebase.Project("default", {project: _default.projectId});
* ```
*
* ## Import
*
* Project can be imported using any of these accepted formats:
*
* * `projects/{{project}}`
*
* * `{{project}}`
*
* When using the `pulumi import` command, Project can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:firebase/project:Project default projects/{{project}}
* ```
*
* ```sh
* $ pulumi import gcp:firebase/project:Project default {{project}}
* ```
*/
export declare class Project extends pulumi.CustomResource {
/**
* Get an existing Project 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?: ProjectState, opts?: pulumi.CustomResourceOptions): Project;
/**
* Returns true if the given object is an instance of Project. 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 Project;
/**
* The GCP project display name
*/
readonly displayName: 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 number of the Google Project that Firebase is enabled on.
*/
readonly projectNumber: pulumi.Output<string>;
/**
* Create a Project 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?: ProjectArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Project resources.
*/
export interface ProjectState {
/**
* The GCP project display 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>;
/**
* The number of the Google Project that Firebase is enabled on.
*/
projectNumber?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Project resource.
*/
export interface ProjectArgs {
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}