gcp logo
Google Cloud Classic v6.48.0, Jan 24 23

gcp.firebase.DatabaseInstance

Import

Instance can be imported using any of these accepted formats

 $ pulumi import gcp:firebase/databaseInstance:DatabaseInstance default projects/{{project}}/locations/{{region}}/instances/{{instance_id}}
 $ pulumi import gcp:firebase/databaseInstance:DatabaseInstance default {{project}}/{{region}}/{{instance_id}}
 $ pulumi import gcp:firebase/databaseInstance:DatabaseInstance default {{region}}/{{instance_id}}
 $ pulumi import gcp:firebase/databaseInstance:DatabaseInstance default {{instance_id}}

Example Usage

Firebase Database Instance Basic

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

return await Deployment.RunAsync(() => 
{
    var basic = new Gcp.Firebase.DatabaseInstance("basic", new()
    {
        Project = "my-project-name",
        Region = "us-central1",
        InstanceId = "active-db",
    }, new CustomResourceOptions
    {
        Provider = google_beta,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := firebase.NewDatabaseInstance(ctx, "basic", &firebase.DatabaseInstanceArgs{
			Project:    pulumi.String("my-project-name"),
			Region:     pulumi.String("us-central1"),
			InstanceId: pulumi.String("active-db"),
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firebase.DatabaseInstance;
import com.pulumi.gcp.firebase.DatabaseInstanceArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
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 basic = new DatabaseInstance("basic", DatabaseInstanceArgs.builder()        
            .project("my-project-name")
            .region("us-central1")
            .instanceId("active-db")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

    }
}
import pulumi
import pulumi_gcp as gcp

basic = gcp.firebase.DatabaseInstance("basic",
    project="my-project-name",
    region="us-central1",
    instance_id="active-db",
    opts=pulumi.ResourceOptions(provider=google_beta))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basic = new gcp.firebase.DatabaseInstance("basic", {
    project: "my-project-name",
    region: "us-central1",
    instanceId: "active-db",
}, {
    provider: google_beta,
});
resources:
  basic:
    type: gcp:firebase:DatabaseInstance
    properties:
      project: my-project-name
      region: us-central1
      instanceId: active-db
    options:
      provider: ${["google-beta"]}

Firebase Database Instance Full

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

return await Deployment.RunAsync(() => 
{
    var full = new Gcp.Firebase.DatabaseInstance("full", new()
    {
        Project = "my-project-name",
        Region = "europe-west1",
        InstanceId = "disabled-db",
        Type = "USER_DATABASE",
        DesiredState = "DISABLED",
    }, new CustomResourceOptions
    {
        Provider = google_beta,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := firebase.NewDatabaseInstance(ctx, "full", &firebase.DatabaseInstanceArgs{
			Project:      pulumi.String("my-project-name"),
			Region:       pulumi.String("europe-west1"),
			InstanceId:   pulumi.String("disabled-db"),
			Type:         pulumi.String("USER_DATABASE"),
			DesiredState: pulumi.String("DISABLED"),
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firebase.DatabaseInstance;
import com.pulumi.gcp.firebase.DatabaseInstanceArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
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 full = new DatabaseInstance("full", DatabaseInstanceArgs.builder()        
            .project("my-project-name")
            .region("europe-west1")
            .instanceId("disabled-db")
            .type("USER_DATABASE")
            .desiredState("DISABLED")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

    }
}
import pulumi
import pulumi_gcp as gcp

full = gcp.firebase.DatabaseInstance("full",
    project="my-project-name",
    region="europe-west1",
    instance_id="disabled-db",
    type="USER_DATABASE",
    desired_state="DISABLED",
    opts=pulumi.ResourceOptions(provider=google_beta))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const full = new gcp.firebase.DatabaseInstance("full", {
    project: "my-project-name",
    region: "europe-west1",
    instanceId: "disabled-db",
    type: "USER_DATABASE",
    desiredState: "DISABLED",
}, {
    provider: google_beta,
});
resources:
  full:
    type: gcp:firebase:DatabaseInstance
    properties:
      project: my-project-name
      region: europe-west1
      instanceId: disabled-db
      type: USER_DATABASE
      desiredState: DISABLED
    options:
      provider: ${["google-beta"]}

Firebase Database Instance Default Database

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

return await Deployment.RunAsync(() => 
{
    var defaultProject = new Gcp.Organizations.Project("defaultProject", new()
    {
        ProjectId = "rtdb-project",
        OrgId = "123456789",
        Labels = 
        {
            { "firebase", "enabled" },
        },
    }, new CustomResourceOptions
    {
        Provider = google_beta,
    });

    var defaultFirebase_projectProject = new Gcp.Firebase.Project("defaultFirebase/projectProject", new()
    {
        ProjectID = defaultProject.ProjectId,
    }, new CustomResourceOptions
    {
        Provider = google_beta,
    });

    var firebaseDatabase = new Gcp.Projects.Service("firebaseDatabase", new()
    {
        Project = defaultFirebase / projectProject.Project,
        ServiceName = "firebasedatabase.googleapis.com",
    }, new CustomResourceOptions
    {
        Provider = google_beta,
    });

    var defaultDatabaseInstance = new Gcp.Firebase.DatabaseInstance("defaultDatabaseInstance", new()
    {
        Project = defaultFirebase / projectProject.Project,
        Region = "us-central1",
        InstanceId = "rtdb-project-default-rtdb",
        Type = "DEFAULT_DATABASE",
    }, new CustomResourceOptions
    {
        Provider = google_beta,
        DependsOn = new[]
        {
            firebaseDatabase,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		defaultProject, err := organizations.NewProject(ctx, "defaultProject", &organizations.ProjectArgs{
			ProjectId: pulumi.String("rtdb-project"),
			OrgId:     pulumi.String("123456789"),
			Labels: pulumi.StringMap{
				"firebase": pulumi.String("enabled"),
			},
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		_, err = firebase.NewProject(ctx, "defaultFirebase/projectProject", &firebase.ProjectArgs{
			Project: defaultProject.ProjectId,
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		firebaseDatabase, err := projects.NewService(ctx, "firebaseDatabase", &projects.ServiceArgs{
			Project: defaultFirebase / projectProject.Project,
			Service: pulumi.String("firebasedatabase.googleapis.com"),
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		_, err = firebase.NewDatabaseInstance(ctx, "defaultDatabaseInstance", &firebase.DatabaseInstanceArgs{
			Project:    defaultFirebase / projectProject.Project,
			Region:     pulumi.String("us-central1"),
			InstanceId: pulumi.String("rtdb-project-default-rtdb"),
			Type:       pulumi.String("DEFAULT_DATABASE"),
		}, pulumi.Provider(google_beta), pulumi.DependsOn([]pulumi.Resource{
			firebaseDatabase,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import com.pulumi.gcp.firebase.Project;
import com.pulumi.gcp.firebase.ProjectArgs;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumi.gcp.firebase.DatabaseInstance;
import com.pulumi.gcp.firebase.DatabaseInstanceArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
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 defaultProject = new Project("defaultProject", ProjectArgs.builder()        
            .projectId("rtdb-project")
            .orgId("123456789")
            .labels(Map.of("firebase", "enabled"))
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

        var defaultFirebase_projectProject = new Project("defaultFirebase/projectProject", ProjectArgs.builder()        
            .project(defaultProject.projectId())
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

        var firebaseDatabase = new Service("firebaseDatabase", ServiceArgs.builder()        
            .project(defaultFirebase / projectProject.project())
            .service("firebasedatabase.googleapis.com")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

        var defaultDatabaseInstance = new DatabaseInstance("defaultDatabaseInstance", DatabaseInstanceArgs.builder()        
            .project(defaultFirebase / projectProject.project())
            .region("us-central1")
            .instanceId("rtdb-project-default-rtdb")
            .type("DEFAULT_DATABASE")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .dependsOn(firebaseDatabase)
                .build());

    }
}
import pulumi
import pulumi_gcp as gcp

default_project = gcp.organizations.Project("defaultProject",
    project_id="rtdb-project",
    org_id="123456789",
    labels={
        "firebase": "enabled",
    },
    opts=pulumi.ResourceOptions(provider=google_beta))
default_firebase_project_project = gcp.firebase.Project("defaultFirebase/projectProject", project=default_project.project_id,
opts=pulumi.ResourceOptions(provider=google_beta))
firebase_database = gcp.projects.Service("firebaseDatabase",
    project=default_firebase / project_project["project"],
    service="firebasedatabase.googleapis.com",
    opts=pulumi.ResourceOptions(provider=google_beta))
default_database_instance = gcp.firebase.DatabaseInstance("defaultDatabaseInstance",
    project=default_firebase / project_project["project"],
    region="us-central1",
    instance_id="rtdb-project-default-rtdb",
    type="DEFAULT_DATABASE",
    opts=pulumi.ResourceOptions(provider=google_beta,
        depends_on=[firebase_database]))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const defaultProject = new gcp.organizations.Project("defaultProject", {
    projectId: "rtdb-project",
    orgId: "123456789",
    labels: {
        firebase: "enabled",
    },
}, {
    provider: google_beta,
});
const defaultFirebase_projectProject = new gcp.firebase.Project("defaultFirebase/projectProject", {project: defaultProject.projectId}, {
    provider: google_beta,
});
const firebaseDatabase = new gcp.projects.Service("firebaseDatabase", {
    project: defaultFirebase / projectProject.project,
    service: "firebasedatabase.googleapis.com",
}, {
    provider: google_beta,
});
const defaultDatabaseInstance = new gcp.firebase.DatabaseInstance("defaultDatabaseInstance", {
    project: defaultFirebase / projectProject.project,
    region: "us-central1",
    instanceId: "rtdb-project-default-rtdb",
    type: "DEFAULT_DATABASE",
}, {
    provider: google_beta,
    dependsOn: [firebaseDatabase],
});

Coming soon!

Create DatabaseInstance Resource

new DatabaseInstance(name: string, args: DatabaseInstanceArgs, opts?: CustomResourceOptions);
@overload
def DatabaseInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     desired_state: Optional[str] = None,
                     instance_id: Optional[str] = None,
                     project: Optional[str] = None,
                     region: Optional[str] = None,
                     type: Optional[str] = None)
@overload
def DatabaseInstance(resource_name: str,
                     args: DatabaseInstanceArgs,
                     opts: Optional[ResourceOptions] = None)
func NewDatabaseInstance(ctx *Context, name string, args DatabaseInstanceArgs, opts ...ResourceOption) (*DatabaseInstance, error)
public DatabaseInstance(string name, DatabaseInstanceArgs args, CustomResourceOptions? opts = null)
public DatabaseInstance(String name, DatabaseInstanceArgs args)
public DatabaseInstance(String name, DatabaseInstanceArgs args, CustomResourceOptions options)
type: gcp:firebase:DatabaseInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DatabaseInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DatabaseInstance resource accepts the following input properties:

InstanceId string

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

Region string

A reference to the region where the Firebase Realtime database resides. Check all available regions

DesiredState string

The intended database state.

Project string

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

Type string

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

InstanceId string

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

Region string

A reference to the region where the Firebase Realtime database resides. Check all available regions

DesiredState string

The intended database state.

Project string

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

Type string

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

instanceId String

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

region String

A reference to the region where the Firebase Realtime database resides. Check all available regions

desiredState String

The intended database state.

project String

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

type String

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

instanceId string

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

region string

A reference to the region where the Firebase Realtime database resides. Check all available regions

desiredState string

The intended database state.

project string

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

type string

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

instance_id str

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

region str

A reference to the region where the Firebase Realtime database resides. Check all available regions

desired_state str

The intended database state.

project str

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

type str

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

instanceId String

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

region String

A reference to the region where the Firebase Realtime database resides. Check all available regions

desiredState String

The intended database state.

project String

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

type String

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

Outputs

All input properties are implicitly available as output properties. Additionally, the DatabaseInstance resource produces the following output properties:

DatabaseUrl string

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

State string

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

DatabaseUrl string

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

State string

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

databaseUrl String

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

id String

The provider-assigned unique ID for this managed resource.

name String

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

state String

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

databaseUrl string

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

id string

The provider-assigned unique ID for this managed resource.

name string

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

state string

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

database_url str

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

id str

The provider-assigned unique ID for this managed resource.

name str

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

state str

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

databaseUrl String

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

id String

The provider-assigned unique ID for this managed resource.

name String

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

state String

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

Look up Existing DatabaseInstance Resource

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

public static get(name: string, id: Input<ID>, state?: DatabaseInstanceState, opts?: CustomResourceOptions): DatabaseInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database_url: Optional[str] = None,
        desired_state: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        state: Optional[str] = None,
        type: Optional[str] = None) -> DatabaseInstance
func GetDatabaseInstance(ctx *Context, name string, id IDInput, state *DatabaseInstanceState, opts ...ResourceOption) (*DatabaseInstance, error)
public static DatabaseInstance Get(string name, Input<string> id, DatabaseInstanceState? state, CustomResourceOptions? opts = null)
public static DatabaseInstance get(String name, Output<String> id, DatabaseInstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DatabaseUrl string

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

DesiredState string

The intended database state.

InstanceId string

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

Name string

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

Project string

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

Region string

A reference to the region where the Firebase Realtime database resides. Check all available regions

State string

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

Type string

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

DatabaseUrl string

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

DesiredState string

The intended database state.

InstanceId string

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

Name string

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

Project string

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

Region string

A reference to the region where the Firebase Realtime database resides. Check all available regions

State string

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

Type string

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

databaseUrl String

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

desiredState String

The intended database state.

instanceId String

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

name String

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

project String

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

region String

A reference to the region where the Firebase Realtime database resides. Check all available regions

state String

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

type String

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

databaseUrl string

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

desiredState string

The intended database state.

instanceId string

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

name string

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

project string

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

region string

A reference to the region where the Firebase Realtime database resides. Check all available regions

state string

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

type string

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

database_url str

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

desired_state str

The intended database state.

instance_id str

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

name str

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

project str

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

region str

A reference to the region where the Firebase Realtime database resides. Check all available regions

state str

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

type str

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

databaseUrl String

The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances or https://{instance-id}.{region}.firebasedatabase.app in other regions.

desiredState String

The intended database state.

instanceId String

The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion.

name String

The fully-qualified resource name of the Firebase Realtime Database, in the format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID PROJECT_NUMBER: The Firebase project's ProjectNumber Learn more about using project identifiers in Google's AIP 2510 standard.

project String

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

region String

A reference to the region where the Firebase Realtime database resides. Check all available regions

state String

The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database

type String

The database type. Each project can create one default Firebase Realtime Database, which cannot be deleted once created. Creating user Databases is only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value is USER_DATABASE. Possible values are DEFAULT_DATABASE and USER_DATABASE.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.