@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
184 lines (183 loc) • 6.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A Google Cloud Firebase web application instance
*
* To get more information about WebApp, see:
*
* * [API documentation](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps)
* * How-to Guides
* * [Official Documentation](https://firebase.google.com/)
*
* ## Example Usage
*
* ### Firebase Web App Custom Api Key
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const web = new gcp.projects.ApiKey("web", {
* project: "my-project-name",
* name: "api-key",
* displayName: "Display Name",
* restrictions: {
* browserKeyRestrictions: {
* allowedReferrers: ["*"],
* },
* },
* });
* const _default = new gcp.firebase.WebApp("default", {
* project: "my-project-name",
* displayName: "Display Name",
* apiKeyId: web.uid,
* deletionPolicy: "DELETE",
* });
* ```
*
* ## Import
*
* WebApp can be imported using any of these accepted formats:
*
* * `{{project}} projects/{{project}}/webApps/{{app_id}}`
*
* * `projects/{{project}}/webApps/{{app_id}}`
*
* * `{{project}}/{{project}}/{{app_id}}`
*
* * `webApps/{{app_id}}`
*
* * `{{app_id}}`
*
* When using the `pulumi import` command, WebApp can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:firebase/webApp:WebApp default "{{project}} projects/{{project}}/webApps/{{app_id}}"
* ```
*
* ```sh
* $ pulumi import gcp:firebase/webApp:WebApp default projects/{{project}}/webApps/{{app_id}}
* ```
*
* ```sh
* $ pulumi import gcp:firebase/webApp:WebApp default {{project}}/{{project}}/{{app_id}}
* ```
*
* ```sh
* $ pulumi import gcp:firebase/webApp:WebApp default webApps/{{app_id}}
* ```
*
* ```sh
* $ pulumi import gcp:firebase/webApp:WebApp default {{app_id}}
* ```
*/
export declare class WebApp extends pulumi.CustomResource {
/**
* Get an existing WebApp 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?: WebAppState, opts?: pulumi.CustomResourceOptions): WebApp;
/**
* Returns true if the given object is an instance of WebApp. 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 WebApp;
/**
* The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp.
* If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the WebApp.
* This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned.
*/
readonly apiKeyId: pulumi.Output<string>;
/**
* The globally unique, Firebase-assigned identifier of the App.
* This identifier should be treated as an opaque token, as the data format is not specified.
*/
readonly appId: pulumi.Output<string>;
/**
* The URLs where the `WebApp` is hosted.
*/
readonly appUrls: pulumi.Output<string[]>;
readonly deletionPolicy: pulumi.Output<string | undefined>;
/**
* The user-assigned display name of the App.
*/
readonly displayName: pulumi.Output<string>;
/**
* The fully qualified resource name of the App, for example:
* projects/projectId/webApps/appId
*/
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>;
/**
* Create a WebApp 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: WebAppArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering WebApp resources.
*/
export interface WebAppState {
/**
* The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp.
* If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the WebApp.
* This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned.
*/
apiKeyId?: pulumi.Input<string>;
/**
* The globally unique, Firebase-assigned identifier of the App.
* This identifier should be treated as an opaque token, as the data format is not specified.
*/
appId?: pulumi.Input<string>;
/**
* The URLs where the `WebApp` is hosted.
*/
appUrls?: pulumi.Input<pulumi.Input<string>[]>;
deletionPolicy?: pulumi.Input<string>;
/**
* The user-assigned display name of the App.
*/
displayName?: pulumi.Input<string>;
/**
* The fully qualified resource name of the App, for example:
* projects/projectId/webApps/appId
*/
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 set of arguments for constructing a WebApp resource.
*/
export interface WebAppArgs {
/**
* The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp.
* If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the WebApp.
* This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned.
*/
apiKeyId?: pulumi.Input<string>;
deletionPolicy?: pulumi.Input<string>;
/**
* The user-assigned display name of the App.
*/
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>;
}