Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. firebasedatabase
  5. firebasedatabase/v1beta
  6. Instance

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.firebasedatabase/v1beta.Instance

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Requests that a new DatabaseInstance be created. The state of a successfully created DatabaseInstance is ACTIVE. 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. Note that it might take a few minutes for billing enablement state to propagate to Firebase systems.

Create Instance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Instance(name: string, args?: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
             args: Optional[InstanceArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             database_id: Optional[str] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             project: Optional[str] = None,
             type: Optional[InstanceType] = None)
func NewInstance(ctx *Context, name string, args *InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs? args = null, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

type: google-native:firebasedatabase/v1beta:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleinstanceResourceResourceFromFirebasedatabasev1beta = new GoogleNative.Firebasedatabase.V1Beta.Instance("exampleinstanceResourceResourceFromFirebasedatabasev1beta", new()
{
    DatabaseId = "string",
    Location = "string",
    Name = "string",
    Project = "string",
    Type = GoogleNative.Firebasedatabase.V1Beta.InstanceType.DatabaseInstanceTypeUnspecified,
});
Copy
example, err := firebasedatabase.NewInstance(ctx, "exampleinstanceResourceResourceFromFirebasedatabasev1beta", &firebasedatabase.InstanceArgs{
	DatabaseId: pulumi.String("string"),
	Location:   pulumi.String("string"),
	Name:       pulumi.String("string"),
	Project:    pulumi.String("string"),
	Type:       firebasedatabase.InstanceTypeDatabaseInstanceTypeUnspecified,
})
Copy
var exampleinstanceResourceResourceFromFirebasedatabasev1beta = new Instance("exampleinstanceResourceResourceFromFirebasedatabasev1beta", InstanceArgs.builder()
    .databaseId("string")
    .location("string")
    .name("string")
    .project("string")
    .type("DATABASE_INSTANCE_TYPE_UNSPECIFIED")
    .build());
Copy
exampleinstance_resource_resource_from_firebasedatabasev1beta = google_native.firebasedatabase.v1beta.Instance("exampleinstanceResourceResourceFromFirebasedatabasev1beta",
    database_id="string",
    location="string",
    name="string",
    project="string",
    type=google_native.firebasedatabase.v1beta.InstanceType.DATABASE_INSTANCE_TYPE_UNSPECIFIED)
Copy
const exampleinstanceResourceResourceFromFirebasedatabasev1beta = new google_native.firebasedatabase.v1beta.Instance("exampleinstanceResourceResourceFromFirebasedatabasev1beta", {
    databaseId: "string",
    location: "string",
    name: "string",
    project: "string",
    type: google_native.firebasedatabase.v1beta.InstanceType.DatabaseInstanceTypeUnspecified,
});
Copy
type: google-native:firebasedatabase/v1beta:Instance
properties:
    databaseId: string
    location: string
    name: string
    project: string
    type: DATABASE_INSTANCE_TYPE_UNSPECIFIED
Copy

Instance Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Instance resource accepts the following input properties:

DatabaseId string
The globally unique identifier of the database instance.
Location Changes to this property will trigger replacement. string
Name string
The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}.
Project Changes to this property will trigger replacement. string
Type Pulumi.GoogleNative.Firebasedatabase.V1Beta.InstanceType
Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
DatabaseId string
The globally unique identifier of the database instance.
Location Changes to this property will trigger replacement. string
Name string
The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}.
Project Changes to this property will trigger replacement. string
Type InstanceType
Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
databaseId String
The globally unique identifier of the database instance.
location Changes to this property will trigger replacement. String
name String
The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}.
project Changes to this property will trigger replacement. String
type InstanceType
Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
databaseId string
The globally unique identifier of the database instance.
location Changes to this property will trigger replacement. string
name string
The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}.
project Changes to this property will trigger replacement. string
type InstanceType
Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
database_id str
The globally unique identifier of the database instance.
location Changes to this property will trigger replacement. str
name str
The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}.
project Changes to this property will trigger replacement. str
type InstanceType
Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
databaseId String
The globally unique identifier of the database instance.
location Changes to this property will trigger replacement. String
name String
The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}.
project Changes to this property will trigger replacement. String
type "DATABASE_INSTANCE_TYPE_UNSPECIFIED" | "DEFAULT_DATABASE" | "USER_DATABASE"
Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.

Outputs

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

DatabaseUrl string
Output Only. The globally unique hostname of the database.
Id string
The provider-assigned unique ID for this managed resource.
State string
The database's lifecycle state. Read-only.
DatabaseUrl string
Output Only. The globally unique hostname of the database.
Id string
The provider-assigned unique ID for this managed resource.
State string
The database's lifecycle state. Read-only.
databaseUrl String
Output Only. The globally unique hostname of the database.
id String
The provider-assigned unique ID for this managed resource.
state String
The database's lifecycle state. Read-only.
databaseUrl string
Output Only. The globally unique hostname of the database.
id string
The provider-assigned unique ID for this managed resource.
state string
The database's lifecycle state. Read-only.
database_url str
Output Only. The globally unique hostname of the database.
id str
The provider-assigned unique ID for this managed resource.
state str
The database's lifecycle state. Read-only.
databaseUrl String
Output Only. The globally unique hostname of the database.
id String
The provider-assigned unique ID for this managed resource.
state String
The database's lifecycle state. Read-only.

Supporting Types

InstanceType
, InstanceTypeArgs

DatabaseInstanceTypeUnspecified
DATABASE_INSTANCE_TYPE_UNSPECIFIEDUnknown state, likely the result of an error on the backend. This is only used for distinguishing unset values.
DefaultDatabase
DEFAULT_DATABASEThe default database that is provisioned when a project is created.
UserDatabase
USER_DATABASEA database that the user created.
InstanceTypeDatabaseInstanceTypeUnspecified
DATABASE_INSTANCE_TYPE_UNSPECIFIEDUnknown state, likely the result of an error on the backend. This is only used for distinguishing unset values.
InstanceTypeDefaultDatabase
DEFAULT_DATABASEThe default database that is provisioned when a project is created.
InstanceTypeUserDatabase
USER_DATABASEA database that the user created.
DatabaseInstanceTypeUnspecified
DATABASE_INSTANCE_TYPE_UNSPECIFIEDUnknown state, likely the result of an error on the backend. This is only used for distinguishing unset values.
DefaultDatabase
DEFAULT_DATABASEThe default database that is provisioned when a project is created.
UserDatabase
USER_DATABASEA database that the user created.
DatabaseInstanceTypeUnspecified
DATABASE_INSTANCE_TYPE_UNSPECIFIEDUnknown state, likely the result of an error on the backend. This is only used for distinguishing unset values.
DefaultDatabase
DEFAULT_DATABASEThe default database that is provisioned when a project is created.
UserDatabase
USER_DATABASEA database that the user created.
DATABASE_INSTANCE_TYPE_UNSPECIFIED
DATABASE_INSTANCE_TYPE_UNSPECIFIEDUnknown state, likely the result of an error on the backend. This is only used for distinguishing unset values.
DEFAULT_DATABASE
DEFAULT_DATABASEThe default database that is provisioned when a project is created.
USER_DATABASE
USER_DATABASEA database that the user created.
"DATABASE_INSTANCE_TYPE_UNSPECIFIED"
DATABASE_INSTANCE_TYPE_UNSPECIFIEDUnknown state, likely the result of an error on the backend. This is only used for distinguishing unset values.
"DEFAULT_DATABASE"
DEFAULT_DATABASEThe default database that is provisioned when a project is created.
"USER_DATABASE"
USER_DATABASEA database that the user created.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native