pulumi-gcp-kotlin/com.pulumi.gcp.firebase.kotlin/DatabaseInstanceArgs

DatabaseInstanceArgs

data class DatabaseInstanceArgs(val desiredState: Output<String>? = null, val instanceId: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<DatabaseInstanceArgs>

Example Usage

Firebase Database Instance Basic

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",
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
basic = gcp.firebase.DatabaseInstance("basic",
    project="my-project-name",
    region="us-central1",
    instance_id="active-db")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
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",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/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"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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 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());
    }
}
Content copied to clipboard
resources:
  basic:
    type: gcp:firebase:DatabaseInstance
    properties:
      project: my-project-name
      region: us-central1
      instanceId: active-db
Content copied to clipboard

Firebase Database Instance Full

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",
});
Content copied to clipboard
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")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
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",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/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"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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 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());
    }
}
Content copied to clipboard
resources:
  full:
    type: gcp:firebase:DatabaseInstance
    properties:
      project: my-project-name
      region: europe-west1
      instanceId: disabled-db
      type: USER_DATABASE
      desiredState: DISABLED
Content copied to clipboard

Firebase Database Instance Default Database

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as time from "@pulumi/time";
const _default = new gcp.organizations.Project("default", {
    projectId: "rtdb-project",
    name: "rtdb-project",
    orgId: "123456789",
    deletionPolicy: "DELETE",
    labels: {
        firebase: "enabled",
    },
});
const firebase = new gcp.projects.Service("firebase", {
    project: _default.projectId,
    service: "firebase.googleapis.com",
    disableOnDestroy: false,
});
const defaultProject = new gcp.firebase.Project("default", {project: _default.projectId}, {
    dependsOn: [firebase],
});
const firebaseDatabase = new gcp.projects.Service("firebase_database", {
    project: defaultProject.project,
    service: "firebasedatabase.googleapis.com",
    disableOnDestroy: false,
});
const wait60Seconds = new time.index.Sleep("wait_60_seconds", {createDuration: "60s"}, {
    dependsOn: [firebaseDatabase],
});
const defaultDatabaseInstance = new gcp.firebase.DatabaseInstance("default", {
    project: defaultProject.project,
    region: "us-central1",
    instanceId: "rtdb-project-default-rtdb",
    type: "DEFAULT_DATABASE",
}, {
    dependsOn: [wait60Seconds],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
import pulumi_time as time
default = gcp.organizations.Project("default",
    project_id="rtdb-project",
    name="rtdb-project",
    org_id="123456789",
    deletion_policy="DELETE",
    labels={
        "firebase": "enabled",
    })
firebase = gcp.projects.Service("firebase",
    project=default.project_id,
    service="firebase.googleapis.com",
    disable_on_destroy=False)
default_project = gcp.firebase.Project("default", project=default.project_id,
opts = pulumi.ResourceOptions(depends_on=[firebase]))
firebase_database = gcp.projects.Service("firebase_database",
    project=default_project.project,
    service="firebasedatabase.googleapis.com",
    disable_on_destroy=False)
wait60_seconds = time.index.Sleep("wait_60_seconds", create_duration=60s,
opts = pulumi.ResourceOptions(depends_on=[firebase_database]))
default_database_instance = gcp.firebase.DatabaseInstance("default",
    project=default_project.project,
    region="us-central1",
    instance_id="rtdb-project-default-rtdb",
    type="DEFAULT_DATABASE",
    opts = pulumi.ResourceOptions(depends_on=[wait60_seconds]))
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Time = Pulumi.Time;
return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Organizations.Project("default", new()
    {
        ProjectId = "rtdb-project",
        Name = "rtdb-project",
        OrgId = "123456789",
        DeletionPolicy = "DELETE",
        Labels =
        {
            { "firebase", "enabled" },
        },
    });
    var firebase = new Gcp.Projects.Service("firebase", new()
    {
        Project = @default.ProjectId,
        ServiceName = "firebase.googleapis.com",
        DisableOnDestroy = false,
    });
    var defaultProject = new Gcp.Firebase.Project("default", new()
    {
        ProjectID = @default.ProjectId,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            firebase,
        },
    });
    var firebaseDatabase = new Gcp.Projects.Service("firebase_database", new()
    {
        Project = defaultProject.ProjectID,
        ServiceName = "firebasedatabase.googleapis.com",
        DisableOnDestroy = false,
    });
    var wait60Seconds = new Time.Index.Sleep("wait_60_seconds", new()
    {
        CreateDuration = "60s",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            firebaseDatabase,
        },
    });
    var defaultDatabaseInstance = new Gcp.Firebase.DatabaseInstance("default", new()
    {
        Project = defaultProject.ProjectID,
        Region = "us-central1",
        InstanceId = "rtdb-project-default-rtdb",
        Type = "DEFAULT_DATABASE",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            wait60Seconds,
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/firebase"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/projects"
	"github.com/pulumi/pulumi-time/sdk/go/time"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := organizations.NewProject(ctx, "default", &organizations.ProjectArgs{
			ProjectId:      pulumi.String("rtdb-project"),
			Name:           pulumi.String("rtdb-project"),
			OrgId:          pulumi.String("123456789"),
			DeletionPolicy: pulumi.String("DELETE"),
			Labels: pulumi.StringMap{
				"firebase": pulumi.String("enabled"),
			},
		})
		if err != nil {
			return err
		}
		firebase, err := projects.NewService(ctx, "firebase", &projects.ServiceArgs{
			Project:          _default.ProjectId,
			Service:          pulumi.String("firebase.googleapis.com"),
			DisableOnDestroy: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		defaultProject, err := firebase.NewProject(ctx, "default", &firebase.ProjectArgs{
			Project: _default.ProjectId,
		}, pulumi.DependsOn([]pulumi.Resource{
			firebase,
		}))
		if err != nil {
			return err
		}
		firebaseDatabase, err := projects.NewService(ctx, "firebase_database", &projects.ServiceArgs{
			Project:          defaultProject.Project,
			Service:          pulumi.String("firebasedatabase.googleapis.com"),
			DisableOnDestroy: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		wait60Seconds, err := time.NewSleep(ctx, "wait_60_seconds", &time.SleepArgs{
			CreateDuration: "60s",
		}, pulumi.DependsOn([]pulumi.Resource{
			firebaseDatabase,
		}))
		if err != nil {
			return err
		}
		_, err = firebase.NewDatabaseInstance(ctx, "default", &firebase.DatabaseInstanceArgs{
			Project:    defaultProject.Project,
			Region:     pulumi.String("us-central1"),
			InstanceId: pulumi.String("rtdb-project-default-rtdb"),
			Type:       pulumi.String("DEFAULT_DATABASE"),
		}, pulumi.DependsOn([]pulumi.Resource{
			wait60Seconds,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumi.time.sleep;
import com.pulumi.time.sleepArgs;
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 default_ = new com.pulumi.gcp.organizations.Project("default", com.pulumi.gcp.organizations.ProjectArgs.builder()
            .projectId("rtdb-project")
            .name("rtdb-project")
            .orgId("123456789")
            .deletionPolicy("DELETE")
            .labels(Map.of("firebase", "enabled"))
            .build());
        var firebase = new Service("firebase", ServiceArgs.builder()
            .project(default_.projectId())
            .service("firebase.googleapis.com")
            .disableOnDestroy(false)
            .build());
        var defaultProject = new com.pulumi.gcp.firebase.Project("defaultProject", com.pulumi.gcp.firebase.ProjectArgs.builder()
            .project(default_.projectId())
            .build(), CustomResourceOptions.builder()
                .dependsOn(firebase)
                .build());
        var firebaseDatabase = new Service("firebaseDatabase", ServiceArgs.builder()
            .project(defaultProject.project())
            .service("firebasedatabase.googleapis.com")
            .disableOnDestroy(false)
            .build());
        var wait60Seconds = new Sleep("wait60Seconds", SleepArgs.builder()
            .createDuration("60s")
            .build(), CustomResourceOptions.builder()
                .dependsOn(List.of(firebaseDatabase))
                .build());
        var defaultDatabaseInstance = new DatabaseInstance("defaultDatabaseInstance", DatabaseInstanceArgs.builder()
            .project(defaultProject.project())
            .region("us-central1")
            .instanceId("rtdb-project-default-rtdb")
            .type("DEFAULT_DATABASE")
            .build(), CustomResourceOptions.builder()
                .dependsOn(wait60Seconds)
                .build());
    }
}
Content copied to clipboard
resources:
  default:
    type: gcp:organizations:Project
    properties:
      projectId: rtdb-project
      name: rtdb-project
      orgId: '123456789'
      deletionPolicy: DELETE
      labels:
        firebase: enabled
  firebase:
    type: gcp:projects:Service
    properties:
      project: ${default.projectId}
      service: firebase.googleapis.com
      disableOnDestroy: false
  defaultProject:
    type: gcp:firebase:Project
    name: default
    properties:
      project: ${default.projectId}
    options:
      dependsOn:
        - ${firebase}
  firebaseDatabase:
    type: gcp:projects:Service
    name: firebase_database
    properties:
      project: ${defaultProject.project}
      service: firebasedatabase.googleapis.com
      disableOnDestroy: false
  wait60Seconds:
    type: time:sleep
    name: wait_60_seconds
    properties:
      createDuration: 60s
    options:
      dependsOn:
        - ${firebaseDatabase}
  defaultDatabaseInstance:
    type: gcp:firebase:DatabaseInstance
    name: default
    properties:
      project: ${defaultProject.project}
      region: us-central1
      instanceId: rtdb-project-default-rtdb
      type: DEFAULT_DATABASE
    options:
      dependsOn:
        - ${wait60Seconds}
Content copied to clipboard

Import

Instance can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{region}}/instances/{{instance_id}}

  • {{project}}/{{region}}/{{instance_id}}

  • {{region}}/{{instance_id}}

  • {{instance_id}} When using the pulumi import command, Instance can be imported using one of the formats above. For example:

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

Constructors

Link copied to clipboard
constructor(desiredState: Output<String>? = null, instanceId: Output<String>? = null, project: Output<String>? = null, region: Output<String>? = null, type: Output<String>? = null)

Properties

Link copied to clipboard
val desiredState: Output<String>? = null

The intended database state. Possible values: ACTIVE, DISABLED.

Link copied to clipboard
val instanceId: Output<String>? = null

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

Link copied to clipboard
val project: Output<String>? = null

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

Link copied to clipboard
val region: Output<String>? = null

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

Link copied to clipboard
val type: Output<String>? = null

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, USER_DATABASE.

Functions

Link copied to clipboard
open override fun toJava(): DatabaseInstanceArgs