1. Docs
  2. Reference
  3. API
  4. @pulumi/gcp
  5. firebase

Module firebase

This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource Project

class Project extends CustomResource

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:

constructor

new Project(name: string, args?: ProjectArgs, opts?: pulumi.CustomResourceOptions)

Create a Project resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectState, opts?: pulumi.CustomResourceOptions): Project

Get an existing Project resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is 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.

property displayName

public displayName: pulumi.Output<string>;

The GCP project display name

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property projectNumber

public projectNumber: pulumi.Output<string>;

The number of the google project that firebase is enabled on.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProjectLocation

class ProjectLocation extends CustomResource

Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject.

This method creates an App Engine application with a default Cloud Storage bucket, located in the specified locationId. This location must be one of the available GCP resource locations.

After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified FirebaseProject might already be set because either the GCP Project already has an App Engine application or defaultLocation.finalize was previously called with a specified locationId. Any new calls to defaultLocation.finalize with a different specified locationId will return a 409 error.

To get more information about ProjectLocation, see:

constructor

new ProjectLocation(name: string, args: ProjectLocationArgs, opts?: pulumi.CustomResourceOptions)

Create a ProjectLocation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectLocationState, opts?: pulumi.CustomResourceOptions): ProjectLocation

Get an existing ProjectLocation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectLocation

Returns true if the given object is an instance of ProjectLocation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property locationId

public locationId: pulumi.Output<string>;

The ID of the default GCP resource location for the Project. The location must be one of the available GCP resource locations.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource WebApp

class WebApp extends CustomResource

A Google Cloud Firebase web application instance

To get more information about WebApp, see:

constructor

new WebApp(name: string, args: WebAppArgs, opts?: pulumi.CustomResourceOptions)

Create a WebApp resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WebAppState, opts?: pulumi.CustomResourceOptions): WebApp

Get an existing WebApp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is 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.

property appId

public appId: pulumi.Output<string>;

Immutable. 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.

property displayName

public displayName: pulumi.Output<string>;

The user-assigned display name of the App.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The fully qualified resource name of the App, for example: projects/projectId/webApps/appId

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getWebApp

getWebApp(args: GetWebAppArgs, opts?: pulumi.InvokeOptions): Promise<GetWebAppResult>

A Google Cloud Firebase web application instance

Function getWebAppConfig

getWebAppConfig(args: GetWebAppConfigArgs, opts?: pulumi.InvokeOptions): Promise<GetWebAppConfigResult>

A Google Cloud Firebase web application configuration

To get more information about WebApp, see:

Others

interface GetWebAppArgs

interface GetWebAppArgs

A collection of arguments for invoking getWebApp.

property appId

appId: string;

The appIp of name of the Firebase webApp.

interface GetWebAppConfigArgs

interface GetWebAppConfigArgs

A collection of arguments for invoking getWebAppConfig.

property project

project?: undefined | string;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property webAppId

webAppId: string;

the id of the firebase web app

interface GetWebAppConfigResult

interface GetWebAppConfigResult

A collection of values returned by getWebAppConfig.

property apiKey

apiKey: string;

property authDomain

authDomain: string;

property databaseUrl

databaseUrl: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property locationId

locationId: string;

property measurementId

measurementId: string;

property messagingSenderId

messagingSenderId: string;

property project

project?: undefined | string;

property storageBucket

storageBucket: string;

property webAppId

webAppId: string;

interface GetWebAppResult

interface GetWebAppResult

A collection of values returned by getWebApp.

property appId

appId: string;

property displayName

displayName: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property project

project: string;

interface ProjectArgs

interface ProjectArgs

The set of arguments for constructing a Project resource.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface ProjectLocationArgs

interface ProjectLocationArgs

The set of arguments for constructing a ProjectLocation resource.

property locationId

locationId: pulumi.Input<string>;

The ID of the default GCP resource location for the Project. The location must be one of the available GCP resource locations.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface ProjectLocationState

interface ProjectLocationState

Input properties used for looking up and filtering ProjectLocation resources.

property locationId

locationId?: pulumi.Input<string>;

The ID of the default GCP resource location for the Project. The location must be one of the available GCP resource locations.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface ProjectState

interface ProjectState

Input properties used for looking up and filtering Project resources.

property displayName

displayName?: pulumi.Input<string>;

The GCP project display name

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property projectNumber

projectNumber?: pulumi.Input<string>;

The number of the google project that firebase is enabled on.

interface WebAppArgs

interface WebAppArgs

The set of arguments for constructing a WebApp resource.

property displayName

displayName: pulumi.Input<string>;

The user-assigned display name of the App.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface WebAppState

interface WebAppState

Input properties used for looking up and filtering WebApp resources.

property appId

appId?: pulumi.Input<string>;

Immutable. 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.

property displayName

displayName?: pulumi.Input<string>;

The user-assigned display name of the App.

property name

name?: pulumi.Input<string>;

The fully qualified resource name of the App, for example: projects/projectId/webApps/appId

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.