WebApp class

A Google Cloud Firebase web application instance

> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

To get more information about WebApp, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Firebase Web App Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as std from "@pulumi/std";

const basicWebApp = new gcp.firebase.WebApp("basic", {
    project: "my-project-name",
    displayName: "Display Name Basic",
});
const basic = gcp.firebase.getWebAppConfigOutput({
    webAppId: basicWebApp.appId,
});
const _default = new gcp.storage.Bucket("default", {
    name: "fb-webapp-",
    location: "US",
});
const defaultBucketObject = new gcp.storage.BucketObject("default", {
    bucket: _default.name,
    name: "firebase-config.json",
    content: pulumi.jsonStringify({
        appId: basicWebApp.appId,
        apiKey: basic.apiKey,
        authDomain: basic.authDomain,
        databaseURL: std.lookupOutput({
            map: basic,
            key: "database_url",
            "default": "",
        }).result,
        storageBucket: std.lookupOutput({
            map: basic,
            key: "storage_bucket",
            "default": "",
        }).result,
        messagingSenderId: std.lookupOutput({
            map: basic,
            key: "messaging_sender_id",
            "default": "",
        }).result,
        measurementId: std.lookupOutput({
            map: basic,
            key: "measurement_id",
            "default": "",
        }).result,
    }),
});

import pulumi
import json
import pulumi_gcp as gcp
import pulumi_std as std

basic_web_app = gcp.firebase.WebApp("basic",
    project="my-project-name",
    display_name="Display Name Basic")
basic = gcp.firebase.get_web_app_config_output(web_app_id=basic_web_app.app_id)
default = gcp.storage.Bucket("default",
    name="fb-webapp-",
    location="US")
default_bucket_object = gcp.storage.BucketObject("default",
    bucket=default.name,
    name="firebase-config.json",
    content=pulumi.Output.json_dumps({
        "appId": basic_web_app.app_id,
        "apiKey": basic.api_key,
        "authDomain": basic.auth_domain,
        "databaseURL": std.lookup_output(map=basic,
            key="database_url",
            default="").result,
        "storageBucket": std.lookup_output(map=basic,
            key="storage_bucket",
            default="").result,
        "messagingSenderId": std.lookup_output(map=basic,
            key="messaging_sender_id",
            default="").result,
        "measurementId": std.lookup_output(map=basic,
            key="measurement_id",
            default="").result,
    }))

using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() =>
{
    var basicWebApp = new Gcp.Firebase.WebApp("basic", new()
    {
        Project = "my-project-name",
        DisplayName = "Display Name Basic",
    });

    var basic = Gcp.Firebase.GetWebAppConfig.Invoke(new()
    {
        WebAppId = basicWebApp.AppId,
    });

    var @default = new Gcp.Storage.Bucket("default", new()
    {
        Name = "fb-webapp-",
        Location = "US",
    });

    var defaultBucketObject = new Gcp.Storage.BucketObject("default", new()
    {
        Bucket = @default.Name,
        Name = "firebase-config.json",
        Content = Output.JsonSerialize(Output.Create(new Dictionary<string, object?>
        {
            ["appId"] = basicWebApp.AppId,
            ["apiKey"] = basic.Apply(getWebAppConfigResult => getWebAppConfigResult.ApiKey),
            ["authDomain"] = basic.Apply(getWebAppConfigResult => getWebAppConfigResult.AuthDomain),
            ["databaseURL"] = Std.Lookup.Invoke(new()
            {
                Map = basic,
                Key = "database_url",
                Default = "",
            }).Apply(invoke => invoke.Result),
            ["storageBucket"] = Std.Lookup.Invoke(new()
            {
                Map = basic,
                Key = "storage_bucket",
                Default = "",
            }).Apply(invoke => invoke.Result),
            ["messagingSenderId"] = Std.Lookup.Invoke(new()
            {
                Map = basic,
                Key = "messaging_sender_id",
                Default = "",
            }).Apply(invoke => invoke.Result),
            ["measurementId"] = Std.Lookup.Invoke(new()
            {
                Map = basic,
                Key = "measurement_id",
                Default = "",
            }).Apply(invoke => invoke.Result),
        })),
    });

});

package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/firebase"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basicWebApp, err := firebase.NewWebApp(ctx, "basic", &firebase.WebAppArgs{
			Project:     pulumi.String("my-project-name"),
			DisplayName: pulumi.String("Display Name Basic"),
		})
		if err != nil {
			return err
		}
		basic := firebase.GetWebAppConfigOutput(ctx, firebase.GetWebAppConfigOutputArgs{
			WebAppId: basicWebApp.AppId,
		}, nil)
		_default, err := storage.NewBucket(ctx, "default", &storage.BucketArgs{
			Name:     pulumi.String("fb-webapp-"),
			Location: pulumi.String("US"),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewBucketObject(ctx, "default", &storage.BucketObjectArgs{
			Bucket: _default.Name,
			Name:   pulumi.String("firebase-config.json"),
			Content: pulumi.All(basicWebApp.AppId, basic, std.LookupOutput(ctx, std.LookupOutputArgs{
				Map:     basic,
				Key:     pulumi.String("database_url"),
				Default: pulumi.Any(""),
			}, nil), std.LookupOutput(ctx, std.LookupOutputArgs{
				Map:     basic,
				Key:     pulumi.String("storage_bucket"),
				Default: pulumi.Any(""),
			}, nil), std.LookupOutput(ctx, std.LookupOutputArgs{
				Map:     basic,
				Key:     pulumi.String("messaging_sender_id"),
				Default: pulumi.Any(""),
			}, nil), std.LookupOutput(ctx, std.LookupOutputArgs{
				Map:     basic,
				Key:     pulumi.String("measurement_id"),
				Default: pulumi.Any(""),
			}, nil)).ApplyT(func(_args []interface{}) (string, error) {
				appId := _args[0].(string)
				basic := _args[1].(firebase.GetWebAppConfigResult)
				invoke := _args[2].(std.LookupResult)
				invoke1 := _args[3].(std.LookupResult)
				invoke2 := _args[4].(std.LookupResult)
				invoke3 := _args[5].(std.LookupResult)
				var _zero string
				tmpJSON0, err := json.Marshal(map[string]interface{}{
					"appId":             appId,
					"apiKey":            basic.ApiKey,
					"authDomain":        basic.AuthDomain,
					"databaseURL":       invoke.Result,
					"storageBucket":     invoke1.Result,
					"messagingSenderId": invoke2.Result,
					"measurementId":     invoke3.Result,
				})
				if err != nil {
					return _zero, err
				}
				json0 := string(tmpJSON0)
				return json0, nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
    std = {
      source = "pulumi/std"
    }
  }
}

data "gcp_firebase_getwebappconfig" "basic" {
  web_app_id = gcp_firebase_webapp.basic.app_id
}

resource "gcp_firebase_webapp" "basic" {
  project      = "my-project-name"
  display_name = "Display Name Basic"
}
resource "gcp_storage_bucket" "default" {
  name     = "fb-webapp-"
  location = "US"
}
resource "gcp_storage_bucketobject" "default" {
  bucket = gcp_storage_bucket.default.name
  name   = "firebase-config.json"
  content = jsonencode({
    "appId"             = gcp_firebase_webapp.basic.app_id
    "apiKey"            = data.gcp_firebase_getwebappconfig.basic.api_key
    "authDomain"        = data.gcp_firebase_getwebappconfig.basic.auth_domain
    "databaseURL"       = lookup(data.gcp_firebase_getwebappconfig.basic, "database_url", "")
    "storageBucket"     = lookup(data.gcp_firebase_getwebappconfig.basic, "storage_bucket", "")
    "messagingSenderId" = lookup(data.gcp_firebase_getwebappconfig.basic, "messaging_sender_id", "")
    "measurementId"     = lookup(data.gcp_firebase_getwebappconfig.basic, "measurement_id", "")
  })
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firebase.WebApp;
import com.pulumi.gcp.firebase.WebAppArgs;
import com.pulumi.gcp.firebase.FirebaseFunctions;
import com.pulumi.gcp.firebase.inputs.GetWebAppConfigArgs;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.storage.BucketObject;
import com.pulumi.gcp.storage.BucketObjectArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.LookupArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var basicWebApp = new WebApp("basicWebApp", WebAppArgs.builder()
            .project("my-project-name")
            .displayName("Display Name Basic")
            .build());

        final var basic = FirebaseFunctions.getWebAppConfig(GetWebAppConfigArgs.builder()
            .webAppId(basicWebApp.appId())
            .build());

        var default_ = new Bucket("default", BucketArgs.builder()
            .name("fb-webapp-")
            .location("US")
            .build());

        var defaultBucketObject = new BucketObject("defaultBucketObject", BucketObjectArgs.builder()
            .bucket(default_.name())
            .name("firebase-config.json")
            .content(Output.tuple(basicWebApp.appId(), basic, StdFunctions.lookup(LookupArgs.builder()
                .map(basic)
                .key("database_url")
                .default_("")
                .build()), StdFunctions.lookup(LookupArgs.builder()
                .map(basic)
                .key("storage_bucket")
                .default_("")
                .build()), StdFunctions.lookup(LookupArgs.builder()
                .map(basic)
                .key("messaging_sender_id")
                .default_("")
                .build()), StdFunctions.lookup(LookupArgs.builder()
                .map(basic)
                .key("measurement_id")
                .default_("")
                .build())).applyValue(values -> {
                var appId = values.t1;
                var basic = values.t2;
                var invoke = values.t3;
                var invoke1 = values.t4;
                var invoke2 = values.t5;
                var invoke3 = values.t6;
                return serializeJson(
                    jsonObject(
                        jsonProperty("appId", appId),
                        jsonProperty("apiKey", basic.apiKey()),
                        jsonProperty("authDomain", basic.authDomain()),
                        jsonProperty("databaseURL", invoke.result()),
                        jsonProperty("storageBucket", invoke1.result()),
                        jsonProperty("messagingSenderId", invoke2.result()),
                        jsonProperty("measurementId", invoke3.result())
                    ));
            }))
            .build());

    }
}

resources:
  basicWebApp:
    type: gcp:firebase:WebApp
    name: basic
    properties:
      project: my-project-name
      displayName: Display Name Basic
  default:
    type: gcp:storage:Bucket
    properties:
      name: fb-webapp-
      location: US
  defaultBucketObject:
    type: gcp:storage:BucketObject
    name: default
    properties:
      bucket: ${default.name}
      name: firebase-config.json
      content:
        fn::toJSON:
          appId: ${basicWebApp.appId}
          apiKey: ${basic.apiKey}
          authDomain: ${basic.authDomain}
          databaseURL:
            fn::invoke:
              function: std:lookup
              arguments:
                map: ${basic}
                key: database_url
                default: ""
              return: result
          storageBucket:
            fn::invoke:
              function: std:lookup
              arguments:
                map: ${basic}
                key: storage_bucket
                default: ""
              return: result
          messagingSenderId:
            fn::invoke:
              function: std:lookup
              arguments:
                map: ${basic}
                key: messaging_sender_id
                default: ""
              return: result
          measurementId:
            fn::invoke:
              function: std:lookup
              arguments:
                map: ${basic}
                key: measurement_id
                default: ""
              return: result
variables:
  basic:
    fn::invoke:
      function: gcp:firebase:getWebAppConfig
      arguments:
        webAppId: ${basicWebApp.appId}

Firebase Web App Custom Api Key

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 pulumi
import pulumi_gcp as gcp

web = gcp.projects.ApiKey("web",
    project="my-project-name",
    name="api-key",
    display_name="Display Name",
    restrictions={
        "browser_key_restrictions": {
            "allowed_referrers": ["*"],
        },
    })
default = gcp.firebase.WebApp("default",
    project="my-project-name",
    display_name="Display Name",
    api_key_id=web.uid,
    deletion_policy="DELETE")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var web = new Gcp.Projects.ApiKey("web", new()
    {
        Project = "my-project-name",
        Name = "api-key",
        DisplayName = "Display Name",
        Restrictions = new Gcp.Projects.Inputs.ApiKeyRestrictionsArgs
        {
            BrowserKeyRestrictions = new Gcp.Projects.Inputs.ApiKeyRestrictionsBrowserKeyRestrictionsArgs
            {
                AllowedReferrers = new[]
                {
                    "*",
                },
            },
        },
    });

    var @default = new Gcp.Firebase.WebApp("default", new()
    {
        Project = "my-project-name",
        DisplayName = "Display Name",
        ApiKeyId = web.Uid,
        DeletionPolicy = "DELETE",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/firebase"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		web, err := projects.NewApiKey(ctx, "web", &projects.ApiKeyArgs{
			Project:     pulumi.String("my-project-name"),
			Name:        pulumi.String("api-key"),
			DisplayName: pulumi.String("Display Name"),
			Restrictions: &projects.ApiKeyRestrictionsArgs{
				BrowserKeyRestrictions: &projects.ApiKeyRestrictionsBrowserKeyRestrictionsArgs{
					AllowedReferrers: pulumi.StringArray{
						pulumi.String("*"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = firebase.NewWebApp(ctx, "default", &firebase.WebAppArgs{
			Project:        pulumi.String("my-project-name"),
			DisplayName:    pulumi.String("Display Name"),
			ApiKeyId:       web.Uid,
			DeletionPolicy: pulumi.String("DELETE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_firebase_webapp" "default" {
  project         = "my-project-name"
  display_name    = "Display Name"
  api_key_id      = gcp_projects_apikey.web.uid
  deletion_policy = "DELETE"
}
resource "gcp_projects_apikey" "web" {
  project      = "my-project-name"
  name         = "api-key"
  display_name = "Display Name"
  restrictions = {
    browser_key_restrictions = {
      allowed_referrers = ["*"]
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.ApiKey;
import com.pulumi.gcp.projects.ApiKeyArgs;
import com.pulumi.gcp.projects.inputs.ApiKeyRestrictionsArgs;
import com.pulumi.gcp.projects.inputs.ApiKeyRestrictionsBrowserKeyRestrictionsArgs;
import com.pulumi.gcp.firebase.WebApp;
import com.pulumi.gcp.firebase.WebAppArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var web = new ApiKey("web", ApiKeyArgs.builder()
            .project("my-project-name")
            .name("api-key")
            .displayName("Display Name")
            .restrictions(ApiKeyRestrictionsArgs.builder()
                .browserKeyRestrictions(ApiKeyRestrictionsBrowserKeyRestrictionsArgs.builder()
                    .allowedReferrers("*")
                    .build())
                .build())
            .build());

        var default_ = new WebApp("default", WebAppArgs.builder()
            .project("my-project-name")
            .displayName("Display Name")
            .apiKeyId(web.uid())
            .deletionPolicy("DELETE")
            .build());

    }
}

resources:
  default:
    type: gcp:firebase:WebApp
    properties:
      project: my-project-name
      displayName: Display Name
      apiKeyId: ${web.uid}
      deletionPolicy: DELETE
  web:
    type: gcp:projects:ApiKey
    properties:
      project: my-project-name
      name: api-key
      displayName: Display Name
      restrictions:
        browserKeyRestrictions:
          allowedReferrers:
            - '*'

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:

$ terraform import google_firebase_web_app.default "{{project}} projects/{{project}}/webApps/{{app_id}}"
$ pulumi import gcp:firebase/webApp:WebApp default projects/{{project}}/webApps/{{app_id}}
$ pulumi import gcp:firebase/webApp:WebApp default {{project}}/{{project}}/{{app_id}}
$ pulumi import gcp:firebase/webApp:WebApp default webApps/{{app_id}}
$ pulumi import gcp:firebase/webApp:WebApp default {{app_id}}

Constructors

WebApp(String name, {WebAppArgs? args, CustomResourceOptions? options})

Creates a new WebApp. name The Pulumi resource name. args Arguments used to configure this WebApp. The set of arguments for WebApp. options Resource options controlling this resource's behavior.

WebApp.reference(String urn)

Creates a typed reference to an existing WebApp resource.

Properties

apiKeyId ↔ Output<String>

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.

late, final

appId ↔ 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.

late, final

appUrls ↔ Output<List<String>>

The URLs where the WebApp is hosted.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

displayName ↔ Output<String>

The user-assigned display name of the App.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

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

late, final

project ↔ Output<String>

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

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {WebAppState? state, CustomResourceOptions? options}) → WebApp

Gets an existing WebApp resource's state with the given name and id.