1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. firestore
  5. Database
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

gcp.firestore.Database

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

    A Cloud Firestore Database.

    If you wish to use Firestore with App Engine, use the gcp.appengine.Application resource instead. If you were previously using the gcp.appengine.Application resource exclusively for managing a Firestore database and would like to use the gcp.firestore.Database resource instead, please follow the instructions here.

    To get more information about Database, see:

    Example Usage

    Firestore Default Database

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const database = new gcp.firestore.Database("database", {
        project: "my-project-name",
        name: "(default)",
        locationId: "nam5",
        type: "FIRESTORE_NATIVE",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    database = gcp.firestore.Database("database",
        project="my-project-name",
        name="(default)",
        location_id="nam5",
        type="FIRESTORE_NATIVE")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/firestore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := firestore.NewDatabase(ctx, "database", &firestore.DatabaseArgs{
    			Project:    pulumi.String("my-project-name"),
    			Name:       pulumi.String("(default)"),
    			LocationId: pulumi.String("nam5"),
    			Type:       pulumi.String("FIRESTORE_NATIVE"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var database = new Gcp.Firestore.Database("database", new()
        {
            Project = "my-project-name",
            Name = "(default)",
            LocationId = "nam5",
            Type = "FIRESTORE_NATIVE",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.firestore.Database;
    import com.pulumi.gcp.firestore.DatabaseArgs;
    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 database = new Database("database", DatabaseArgs.builder()
                .project("my-project-name")
                .name("(default)")
                .locationId("nam5")
                .type("FIRESTORE_NATIVE")
                .build());
    
        }
    }
    
    resources:
      database:
        type: gcp:firestore:Database
        properties:
          project: my-project-name
          name: (default)
          locationId: nam5
          type: FIRESTORE_NATIVE
    

    Firestore Database

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const database = new gcp.firestore.Database("database", {
        project: "my-project-name",
        name: "database-id",
        locationId: "nam5",
        type: "FIRESTORE_NATIVE",
        concurrencyMode: "OPTIMISTIC",
        appEngineIntegrationMode: "DISABLED",
        pointInTimeRecoveryEnablement: "POINT_IN_TIME_RECOVERY_ENABLED",
        deleteProtectionState: "DELETE_PROTECTION_ENABLED",
        deletionPolicy: "DELETE",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    database = gcp.firestore.Database("database",
        project="my-project-name",
        name="database-id",
        location_id="nam5",
        type="FIRESTORE_NATIVE",
        concurrency_mode="OPTIMISTIC",
        app_engine_integration_mode="DISABLED",
        point_in_time_recovery_enablement="POINT_IN_TIME_RECOVERY_ENABLED",
        delete_protection_state="DELETE_PROTECTION_ENABLED",
        deletion_policy="DELETE")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/firestore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := firestore.NewDatabase(ctx, "database", &firestore.DatabaseArgs{
    			Project:                       pulumi.String("my-project-name"),
    			Name:                          pulumi.String("database-id"),
    			LocationId:                    pulumi.String("nam5"),
    			Type:                          pulumi.String("FIRESTORE_NATIVE"),
    			ConcurrencyMode:               pulumi.String("OPTIMISTIC"),
    			AppEngineIntegrationMode:      pulumi.String("DISABLED"),
    			PointInTimeRecoveryEnablement: pulumi.String("POINT_IN_TIME_RECOVERY_ENABLED"),
    			DeleteProtectionState:         pulumi.String("DELETE_PROTECTION_ENABLED"),
    			DeletionPolicy:                pulumi.String("DELETE"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var database = new Gcp.Firestore.Database("database", new()
        {
            Project = "my-project-name",
            Name = "database-id",
            LocationId = "nam5",
            Type = "FIRESTORE_NATIVE",
            ConcurrencyMode = "OPTIMISTIC",
            AppEngineIntegrationMode = "DISABLED",
            PointInTimeRecoveryEnablement = "POINT_IN_TIME_RECOVERY_ENABLED",
            DeleteProtectionState = "DELETE_PROTECTION_ENABLED",
            DeletionPolicy = "DELETE",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.firestore.Database;
    import com.pulumi.gcp.firestore.DatabaseArgs;
    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 database = new Database("database", DatabaseArgs.builder()
                .project("my-project-name")
                .name("database-id")
                .locationId("nam5")
                .type("FIRESTORE_NATIVE")
                .concurrencyMode("OPTIMISTIC")
                .appEngineIntegrationMode("DISABLED")
                .pointInTimeRecoveryEnablement("POINT_IN_TIME_RECOVERY_ENABLED")
                .deleteProtectionState("DELETE_PROTECTION_ENABLED")
                .deletionPolicy("DELETE")
                .build());
    
        }
    }
    
    resources:
      database:
        type: gcp:firestore:Database
        properties:
          project: my-project-name
          name: database-id
          locationId: nam5
          type: FIRESTORE_NATIVE
          concurrencyMode: OPTIMISTIC
          appEngineIntegrationMode: DISABLED
          pointInTimeRecoveryEnablement: POINT_IN_TIME_RECOVERY_ENABLED
          deleteProtectionState: DELETE_PROTECTION_ENABLED
          deletionPolicy: DELETE
    

    Firestore Cmek Database

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const project = gcp.organizations.getProject({});
    const keyRing = new gcp.kms.KeyRing("key_ring", {
        name: "kms-key-ring",
        location: "us",
    });
    const cryptoKey = new gcp.kms.CryptoKey("crypto_key", {
        name: "kms-key",
        keyRing: keyRing.id,
        purpose: "ENCRYPT_DECRYPT",
    });
    const firestoreCmekKeyuser = new gcp.kms.CryptoKeyIAMBinding("firestore_cmek_keyuser", {
        cryptoKeyId: cryptoKey.id,
        role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
        members: [project.then(project => `serviceAccount:service-${project.number}@gcp-sa-firestore.iam.gserviceaccount.com`)],
    });
    const database = new gcp.firestore.Database("database", {
        project: "my-project-name",
        name: "cmek-database-id",
        locationId: "nam5",
        type: "FIRESTORE_NATIVE",
        concurrencyMode: "OPTIMISTIC",
        appEngineIntegrationMode: "DISABLED",
        pointInTimeRecoveryEnablement: "POINT_IN_TIME_RECOVERY_ENABLED",
        deleteProtectionState: "DELETE_PROTECTION_ENABLED",
        deletionPolicy: "DELETE",
        cmekConfig: {
            kmsKeyName: cryptoKey.id,
        },
    }, {
        dependsOn: [firestoreCmekKeyuser],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    project = gcp.organizations.get_project()
    key_ring = gcp.kms.KeyRing("key_ring",
        name="kms-key-ring",
        location="us")
    crypto_key = gcp.kms.CryptoKey("crypto_key",
        name="kms-key",
        key_ring=key_ring.id,
        purpose="ENCRYPT_DECRYPT")
    firestore_cmek_keyuser = gcp.kms.CryptoKeyIAMBinding("firestore_cmek_keyuser",
        crypto_key_id=crypto_key.id,
        role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
        members=[f"serviceAccount:service-{project.number}@gcp-sa-firestore.iam.gserviceaccount.com"])
    database = gcp.firestore.Database("database",
        project="my-project-name",
        name="cmek-database-id",
        location_id="nam5",
        type="FIRESTORE_NATIVE",
        concurrency_mode="OPTIMISTIC",
        app_engine_integration_mode="DISABLED",
        point_in_time_recovery_enablement="POINT_IN_TIME_RECOVERY_ENABLED",
        delete_protection_state="DELETE_PROTECTION_ENABLED",
        deletion_policy="DELETE",
        cmek_config=gcp.firestore.DatabaseCmekConfigArgs(
            kms_key_name=crypto_key.id,
        ),
        opts=pulumi.ResourceOptions(depends_on=[firestore_cmek_keyuser]))
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/firestore"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		project, err := organizations.LookupProject(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		keyRing, err := kms.NewKeyRing(ctx, "key_ring", &kms.KeyRingArgs{
    			Name:     pulumi.String("kms-key-ring"),
    			Location: pulumi.String("us"),
    		})
    		if err != nil {
    			return err
    		}
    		cryptoKey, err := kms.NewCryptoKey(ctx, "crypto_key", &kms.CryptoKeyArgs{
    			Name:    pulumi.String("kms-key"),
    			KeyRing: keyRing.ID(),
    			Purpose: pulumi.String("ENCRYPT_DECRYPT"),
    		})
    		if err != nil {
    			return err
    		}
    		firestoreCmekKeyuser, err := kms.NewCryptoKeyIAMBinding(ctx, "firestore_cmek_keyuser", &kms.CryptoKeyIAMBindingArgs{
    			CryptoKeyId: cryptoKey.ID(),
    			Role:        pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
    			Members: pulumi.StringArray{
    				pulumi.String(fmt.Sprintf("serviceAccount:service-%v@gcp-sa-firestore.iam.gserviceaccount.com", project.Number)),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = firestore.NewDatabase(ctx, "database", &firestore.DatabaseArgs{
    			Project:                       pulumi.String("my-project-name"),
    			Name:                          pulumi.String("cmek-database-id"),
    			LocationId:                    pulumi.String("nam5"),
    			Type:                          pulumi.String("FIRESTORE_NATIVE"),
    			ConcurrencyMode:               pulumi.String("OPTIMISTIC"),
    			AppEngineIntegrationMode:      pulumi.String("DISABLED"),
    			PointInTimeRecoveryEnablement: pulumi.String("POINT_IN_TIME_RECOVERY_ENABLED"),
    			DeleteProtectionState:         pulumi.String("DELETE_PROTECTION_ENABLED"),
    			DeletionPolicy:                pulumi.String("DELETE"),
    			CmekConfig: &firestore.DatabaseCmekConfigArgs{
    				KmsKeyName: cryptoKey.ID(),
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			firestoreCmekKeyuser,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var project = Gcp.Organizations.GetProject.Invoke();
    
        var keyRing = new Gcp.Kms.KeyRing("key_ring", new()
        {
            Name = "kms-key-ring",
            Location = "us",
        });
    
        var cryptoKey = new Gcp.Kms.CryptoKey("crypto_key", new()
        {
            Name = "kms-key",
            KeyRing = keyRing.Id,
            Purpose = "ENCRYPT_DECRYPT",
        });
    
        var firestoreCmekKeyuser = new Gcp.Kms.CryptoKeyIAMBinding("firestore_cmek_keyuser", new()
        {
            CryptoKeyId = cryptoKey.Id,
            Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
            Members = new[]
            {
                $"serviceAccount:service-{project.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-firestore.iam.gserviceaccount.com",
            },
        });
    
        var database = new Gcp.Firestore.Database("database", new()
        {
            Project = "my-project-name",
            Name = "cmek-database-id",
            LocationId = "nam5",
            Type = "FIRESTORE_NATIVE",
            ConcurrencyMode = "OPTIMISTIC",
            AppEngineIntegrationMode = "DISABLED",
            PointInTimeRecoveryEnablement = "POINT_IN_TIME_RECOVERY_ENABLED",
            DeleteProtectionState = "DELETE_PROTECTION_ENABLED",
            DeletionPolicy = "DELETE",
            CmekConfig = new Gcp.Firestore.Inputs.DatabaseCmekConfigArgs
            {
                KmsKeyName = cryptoKey.Id,
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                firestoreCmekKeyuser,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.organizations.OrganizationsFunctions;
    import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
    import com.pulumi.gcp.kms.KeyRing;
    import com.pulumi.gcp.kms.KeyRingArgs;
    import com.pulumi.gcp.kms.CryptoKey;
    import com.pulumi.gcp.kms.CryptoKeyArgs;
    import com.pulumi.gcp.kms.CryptoKeyIAMBinding;
    import com.pulumi.gcp.kms.CryptoKeyIAMBindingArgs;
    import com.pulumi.gcp.firestore.Database;
    import com.pulumi.gcp.firestore.DatabaseArgs;
    import com.pulumi.gcp.firestore.inputs.DatabaseCmekConfigArgs;
    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) {
            final var project = OrganizationsFunctions.getProject();
    
            var keyRing = new KeyRing("keyRing", KeyRingArgs.builder()
                .name("kms-key-ring")
                .location("us")
                .build());
    
            var cryptoKey = new CryptoKey("cryptoKey", CryptoKeyArgs.builder()
                .name("kms-key")
                .keyRing(keyRing.id())
                .purpose("ENCRYPT_DECRYPT")
                .build());
    
            var firestoreCmekKeyuser = new CryptoKeyIAMBinding("firestoreCmekKeyuser", CryptoKeyIAMBindingArgs.builder()
                .cryptoKeyId(cryptoKey.id())
                .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
                .members(String.format("serviceAccount:service-%s@gcp-sa-firestore.iam.gserviceaccount.com", project.applyValue(getProjectResult -> getProjectResult.number())))
                .build());
    
            var database = new Database("database", DatabaseArgs.builder()
                .project("my-project-name")
                .name("cmek-database-id")
                .locationId("nam5")
                .type("FIRESTORE_NATIVE")
                .concurrencyMode("OPTIMISTIC")
                .appEngineIntegrationMode("DISABLED")
                .pointInTimeRecoveryEnablement("POINT_IN_TIME_RECOVERY_ENABLED")
                .deleteProtectionState("DELETE_PROTECTION_ENABLED")
                .deletionPolicy("DELETE")
                .cmekConfig(DatabaseCmekConfigArgs.builder()
                    .kmsKeyName(cryptoKey.id())
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(firestoreCmekKeyuser)
                    .build());
    
        }
    }
    
    resources:
      database:
        type: gcp:firestore:Database
        properties:
          project: my-project-name
          name: cmek-database-id
          locationId: nam5
          type: FIRESTORE_NATIVE
          concurrencyMode: OPTIMISTIC
          appEngineIntegrationMode: DISABLED
          pointInTimeRecoveryEnablement: POINT_IN_TIME_RECOVERY_ENABLED
          deleteProtectionState: DELETE_PROTECTION_ENABLED
          deletionPolicy: DELETE
          cmekConfig:
            kmsKeyName: ${cryptoKey.id}
        options:
          dependson:
            - ${firestoreCmekKeyuser}
      cryptoKey:
        type: gcp:kms:CryptoKey
        name: crypto_key
        properties:
          name: kms-key
          keyRing: ${keyRing.id}
          purpose: ENCRYPT_DECRYPT
      keyRing:
        type: gcp:kms:KeyRing
        name: key_ring
        properties:
          name: kms-key-ring
          location: us
      firestoreCmekKeyuser:
        type: gcp:kms:CryptoKeyIAMBinding
        name: firestore_cmek_keyuser
        properties:
          cryptoKeyId: ${cryptoKey.id}
          role: roles/cloudkms.cryptoKeyEncrypterDecrypter
          members:
            - serviceAccount:service-${project.number}@gcp-sa-firestore.iam.gserviceaccount.com
    variables:
      project:
        fn::invoke:
          Function: gcp:organizations:getProject
          Arguments: {}
    

    Firestore Default Database In Datastore Mode

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const datastoreModeDatabase = new gcp.firestore.Database("datastore_mode_database", {
        project: "my-project-name",
        name: "(default)",
        locationId: "nam5",
        type: "DATASTORE_MODE",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    datastore_mode_database = gcp.firestore.Database("datastore_mode_database",
        project="my-project-name",
        name="(default)",
        location_id="nam5",
        type="DATASTORE_MODE")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/firestore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := firestore.NewDatabase(ctx, "datastore_mode_database", &firestore.DatabaseArgs{
    			Project:    pulumi.String("my-project-name"),
    			Name:       pulumi.String("(default)"),
    			LocationId: pulumi.String("nam5"),
    			Type:       pulumi.String("DATASTORE_MODE"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var datastoreModeDatabase = new Gcp.Firestore.Database("datastore_mode_database", new()
        {
            Project = "my-project-name",
            Name = "(default)",
            LocationId = "nam5",
            Type = "DATASTORE_MODE",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.firestore.Database;
    import com.pulumi.gcp.firestore.DatabaseArgs;
    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 datastoreModeDatabase = new Database("datastoreModeDatabase", DatabaseArgs.builder()
                .project("my-project-name")
                .name("(default)")
                .locationId("nam5")
                .type("DATASTORE_MODE")
                .build());
    
        }
    }
    
    resources:
      datastoreModeDatabase:
        type: gcp:firestore:Database
        name: datastore_mode_database
        properties:
          project: my-project-name
          name: (default)
          locationId: nam5
          type: DATASTORE_MODE
    

    Firestore Database In Datastore Mode

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const datastoreModeDatabase = new gcp.firestore.Database("datastore_mode_database", {
        project: "my-project-name",
        name: "database-id",
        locationId: "nam5",
        type: "DATASTORE_MODE",
        concurrencyMode: "OPTIMISTIC",
        appEngineIntegrationMode: "DISABLED",
        pointInTimeRecoveryEnablement: "POINT_IN_TIME_RECOVERY_ENABLED",
        deleteProtectionState: "DELETE_PROTECTION_ENABLED",
        deletionPolicy: "DELETE",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    datastore_mode_database = gcp.firestore.Database("datastore_mode_database",
        project="my-project-name",
        name="database-id",
        location_id="nam5",
        type="DATASTORE_MODE",
        concurrency_mode="OPTIMISTIC",
        app_engine_integration_mode="DISABLED",
        point_in_time_recovery_enablement="POINT_IN_TIME_RECOVERY_ENABLED",
        delete_protection_state="DELETE_PROTECTION_ENABLED",
        deletion_policy="DELETE")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/firestore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := firestore.NewDatabase(ctx, "datastore_mode_database", &firestore.DatabaseArgs{
    			Project:                       pulumi.String("my-project-name"),
    			Name:                          pulumi.String("database-id"),
    			LocationId:                    pulumi.String("nam5"),
    			Type:                          pulumi.String("DATASTORE_MODE"),
    			ConcurrencyMode:               pulumi.String("OPTIMISTIC"),
    			AppEngineIntegrationMode:      pulumi.String("DISABLED"),
    			PointInTimeRecoveryEnablement: pulumi.String("POINT_IN_TIME_RECOVERY_ENABLED"),
    			DeleteProtectionState:         pulumi.String("DELETE_PROTECTION_ENABLED"),
    			DeletionPolicy:                pulumi.String("DELETE"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var datastoreModeDatabase = new Gcp.Firestore.Database("datastore_mode_database", new()
        {
            Project = "my-project-name",
            Name = "database-id",
            LocationId = "nam5",
            Type = "DATASTORE_MODE",
            ConcurrencyMode = "OPTIMISTIC",
            AppEngineIntegrationMode = "DISABLED",
            PointInTimeRecoveryEnablement = "POINT_IN_TIME_RECOVERY_ENABLED",
            DeleteProtectionState = "DELETE_PROTECTION_ENABLED",
            DeletionPolicy = "DELETE",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.firestore.Database;
    import com.pulumi.gcp.firestore.DatabaseArgs;
    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 datastoreModeDatabase = new Database("datastoreModeDatabase", DatabaseArgs.builder()
                .project("my-project-name")
                .name("database-id")
                .locationId("nam5")
                .type("DATASTORE_MODE")
                .concurrencyMode("OPTIMISTIC")
                .appEngineIntegrationMode("DISABLED")
                .pointInTimeRecoveryEnablement("POINT_IN_TIME_RECOVERY_ENABLED")
                .deleteProtectionState("DELETE_PROTECTION_ENABLED")
                .deletionPolicy("DELETE")
                .build());
    
        }
    }
    
    resources:
      datastoreModeDatabase:
        type: gcp:firestore:Database
        name: datastore_mode_database
        properties:
          project: my-project-name
          name: database-id
          locationId: nam5
          type: DATASTORE_MODE
          concurrencyMode: OPTIMISTIC
          appEngineIntegrationMode: DISABLED
          pointInTimeRecoveryEnablement: POINT_IN_TIME_RECOVERY_ENABLED
          deleteProtectionState: DELETE_PROTECTION_ENABLED
          deletionPolicy: DELETE
    

    Firestore Cmek Database In Datastore Mode

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const project = gcp.organizations.getProject({});
    const keyRing = new gcp.kms.KeyRing("key_ring", {
        name: "kms-key-ring",
        location: "us",
    });
    const cryptoKey = new gcp.kms.CryptoKey("crypto_key", {
        name: "kms-key",
        keyRing: keyRing.id,
        purpose: "ENCRYPT_DECRYPT",
    });
    const firestoreCmekKeyuser = new gcp.kms.CryptoKeyIAMBinding("firestore_cmek_keyuser", {
        cryptoKeyId: cryptoKey.id,
        role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
        members: [project.then(project => `serviceAccount:service-${project.number}@gcp-sa-firestore.iam.gserviceaccount.com`)],
    });
    const database = new gcp.firestore.Database("database", {
        project: "my-project-name",
        name: "cmek-database-id",
        locationId: "nam5",
        type: "DATASTORE_MODE",
        concurrencyMode: "OPTIMISTIC",
        appEngineIntegrationMode: "DISABLED",
        pointInTimeRecoveryEnablement: "POINT_IN_TIME_RECOVERY_ENABLED",
        deleteProtectionState: "DELETE_PROTECTION_ENABLED",
        deletionPolicy: "DELETE",
        cmekConfig: {
            kmsKeyName: cryptoKey.id,
        },
    }, {
        dependsOn: [firestoreCmekKeyuser],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    project = gcp.organizations.get_project()
    key_ring = gcp.kms.KeyRing("key_ring",
        name="kms-key-ring",
        location="us")
    crypto_key = gcp.kms.CryptoKey("crypto_key",
        name="kms-key",
        key_ring=key_ring.id,
        purpose="ENCRYPT_DECRYPT")
    firestore_cmek_keyuser = gcp.kms.CryptoKeyIAMBinding("firestore_cmek_keyuser",
        crypto_key_id=crypto_key.id,
        role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
        members=[f"serviceAccount:service-{project.number}@gcp-sa-firestore.iam.gserviceaccount.com"])
    database = gcp.firestore.Database("database",
        project="my-project-name",
        name="cmek-database-id",
        location_id="nam5",
        type="DATASTORE_MODE",
        concurrency_mode="OPTIMISTIC",
        app_engine_integration_mode="DISABLED",
        point_in_time_recovery_enablement="POINT_IN_TIME_RECOVERY_ENABLED",
        delete_protection_state="DELETE_PROTECTION_ENABLED",
        deletion_policy="DELETE",
        cmek_config=gcp.firestore.DatabaseCmekConfigArgs(
            kms_key_name=crypto_key.id,
        ),
        opts=pulumi.ResourceOptions(depends_on=[firestore_cmek_keyuser]))
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/firestore"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		project, err := organizations.LookupProject(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		keyRing, err := kms.NewKeyRing(ctx, "key_ring", &kms.KeyRingArgs{
    			Name:     pulumi.String("kms-key-ring"),
    			Location: pulumi.String("us"),
    		})
    		if err != nil {
    			return err
    		}
    		cryptoKey, err := kms.NewCryptoKey(ctx, "crypto_key", &kms.CryptoKeyArgs{
    			Name:    pulumi.String("kms-key"),
    			KeyRing: keyRing.ID(),
    			Purpose: pulumi.String("ENCRYPT_DECRYPT"),
    		})
    		if err != nil {
    			return err
    		}
    		firestoreCmekKeyuser, err := kms.NewCryptoKeyIAMBinding(ctx, "firestore_cmek_keyuser", &kms.CryptoKeyIAMBindingArgs{
    			CryptoKeyId: cryptoKey.ID(),
    			Role:        pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
    			Members: pulumi.StringArray{
    				pulumi.String(fmt.Sprintf("serviceAccount:service-%v@gcp-sa-firestore.iam.gserviceaccount.com", project.Number)),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = firestore.NewDatabase(ctx, "database", &firestore.DatabaseArgs{
    			Project:                       pulumi.String("my-project-name"),
    			Name:                          pulumi.String("cmek-database-id"),
    			LocationId:                    pulumi.String("nam5"),
    			Type:                          pulumi.String("DATASTORE_MODE"),
    			ConcurrencyMode:               pulumi.String("OPTIMISTIC"),
    			AppEngineIntegrationMode:      pulumi.String("DISABLED"),
    			PointInTimeRecoveryEnablement: pulumi.String("POINT_IN_TIME_RECOVERY_ENABLED"),
    			DeleteProtectionState:         pulumi.String("DELETE_PROTECTION_ENABLED"),
    			DeletionPolicy:                pulumi.String("DELETE"),
    			CmekConfig: &firestore.DatabaseCmekConfigArgs{
    				KmsKeyName: cryptoKey.ID(),
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			firestoreCmekKeyuser,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var project = Gcp.Organizations.GetProject.Invoke();
    
        var keyRing = new Gcp.Kms.KeyRing("key_ring", new()
        {
            Name = "kms-key-ring",
            Location = "us",
        });
    
        var cryptoKey = new Gcp.Kms.CryptoKey("crypto_key", new()
        {
            Name = "kms-key",
            KeyRing = keyRing.Id,
            Purpose = "ENCRYPT_DECRYPT",
        });
    
        var firestoreCmekKeyuser = new Gcp.Kms.CryptoKeyIAMBinding("firestore_cmek_keyuser", new()
        {
            CryptoKeyId = cryptoKey.Id,
            Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
            Members = new[]
            {
                $"serviceAccount:service-{project.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-firestore.iam.gserviceaccount.com",
            },
        });
    
        var database = new Gcp.Firestore.Database("database", new()
        {
            Project = "my-project-name",
            Name = "cmek-database-id",
            LocationId = "nam5",
            Type = "DATASTORE_MODE",
            ConcurrencyMode = "OPTIMISTIC",
            AppEngineIntegrationMode = "DISABLED",
            PointInTimeRecoveryEnablement = "POINT_IN_TIME_RECOVERY_ENABLED",
            DeleteProtectionState = "DELETE_PROTECTION_ENABLED",
            DeletionPolicy = "DELETE",
            CmekConfig = new Gcp.Firestore.Inputs.DatabaseCmekConfigArgs
            {
                KmsKeyName = cryptoKey.Id,
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                firestoreCmekKeyuser,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.organizations.OrganizationsFunctions;
    import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
    import com.pulumi.gcp.kms.KeyRing;
    import com.pulumi.gcp.kms.KeyRingArgs;
    import com.pulumi.gcp.kms.CryptoKey;
    import com.pulumi.gcp.kms.CryptoKeyArgs;
    import com.pulumi.gcp.kms.CryptoKeyIAMBinding;
    import com.pulumi.gcp.kms.CryptoKeyIAMBindingArgs;
    import com.pulumi.gcp.firestore.Database;
    import com.pulumi.gcp.firestore.DatabaseArgs;
    import com.pulumi.gcp.firestore.inputs.DatabaseCmekConfigArgs;
    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) {
            final var project = OrganizationsFunctions.getProject();
    
            var keyRing = new KeyRing("keyRing", KeyRingArgs.builder()
                .name("kms-key-ring")
                .location("us")
                .build());
    
            var cryptoKey = new CryptoKey("cryptoKey", CryptoKeyArgs.builder()
                .name("kms-key")
                .keyRing(keyRing.id())
                .purpose("ENCRYPT_DECRYPT")
                .build());
    
            var firestoreCmekKeyuser = new CryptoKeyIAMBinding("firestoreCmekKeyuser", CryptoKeyIAMBindingArgs.builder()
                .cryptoKeyId(cryptoKey.id())
                .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
                .members(String.format("serviceAccount:service-%s@gcp-sa-firestore.iam.gserviceaccount.com", project.applyValue(getProjectResult -> getProjectResult.number())))
                .build());
    
            var database = new Database("database", DatabaseArgs.builder()
                .project("my-project-name")
                .name("cmek-database-id")
                .locationId("nam5")
                .type("DATASTORE_MODE")
                .concurrencyMode("OPTIMISTIC")
                .appEngineIntegrationMode("DISABLED")
                .pointInTimeRecoveryEnablement("POINT_IN_TIME_RECOVERY_ENABLED")
                .deleteProtectionState("DELETE_PROTECTION_ENABLED")
                .deletionPolicy("DELETE")
                .cmekConfig(DatabaseCmekConfigArgs.builder()
                    .kmsKeyName(cryptoKey.id())
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(firestoreCmekKeyuser)
                    .build());
    
        }
    }
    
    resources:
      database:
        type: gcp:firestore:Database
        properties:
          project: my-project-name
          name: cmek-database-id
          locationId: nam5
          type: DATASTORE_MODE
          concurrencyMode: OPTIMISTIC
          appEngineIntegrationMode: DISABLED
          pointInTimeRecoveryEnablement: POINT_IN_TIME_RECOVERY_ENABLED
          deleteProtectionState: DELETE_PROTECTION_ENABLED
          deletionPolicy: DELETE
          cmekConfig:
            kmsKeyName: ${cryptoKey.id}
        options:
          dependson:
            - ${firestoreCmekKeyuser}
      cryptoKey:
        type: gcp:kms:CryptoKey
        name: crypto_key
        properties:
          name: kms-key
          keyRing: ${keyRing.id}
          purpose: ENCRYPT_DECRYPT
      keyRing:
        type: gcp:kms:KeyRing
        name: key_ring
        properties:
          name: kms-key-ring
          location: us
      firestoreCmekKeyuser:
        type: gcp:kms:CryptoKeyIAMBinding
        name: firestore_cmek_keyuser
        properties:
          cryptoKeyId: ${cryptoKey.id}
          role: roles/cloudkms.cryptoKeyEncrypterDecrypter
          members:
            - serviceAccount:service-${project.number}@gcp-sa-firestore.iam.gserviceaccount.com
    variables:
      project:
        fn::invoke:
          Function: gcp:organizations:getProject
          Arguments: {}
    

    Create Database Resource

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

    Constructor syntax

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def Database(resource_name: str,
                 args: DatabaseArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Database(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 location_id: Optional[str] = None,
                 type: Optional[str] = None,
                 app_engine_integration_mode: Optional[str] = None,
                 cmek_config: Optional[DatabaseCmekConfigArgs] = None,
                 concurrency_mode: Optional[str] = None,
                 delete_protection_state: Optional[str] = None,
                 deletion_policy: Optional[str] = None,
                 name: Optional[str] = None,
                 point_in_time_recovery_enablement: Optional[str] = None,
                 project: Optional[str] = None)
    func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
    public Database(String name, DatabaseArgs args, CustomResourceOptions options)
    
    type: gcp:firestore:Database
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DatabaseArgs
    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 DatabaseArgs
    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 DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var gcpDatabaseResource = new Gcp.Firestore.Database("gcpDatabaseResource", new()
    {
        LocationId = "string",
        Type = "string",
        AppEngineIntegrationMode = "string",
        CmekConfig = new Gcp.Firestore.Inputs.DatabaseCmekConfigArgs
        {
            KmsKeyName = "string",
            ActiveKeyVersions = new[]
            {
                "string",
            },
        },
        ConcurrencyMode = "string",
        DeleteProtectionState = "string",
        DeletionPolicy = "string",
        Name = "string",
        PointInTimeRecoveryEnablement = "string",
        Project = "string",
    });
    
    example, err := firestore.NewDatabase(ctx, "gcpDatabaseResource", &firestore.DatabaseArgs{
    	LocationId:               pulumi.String("string"),
    	Type:                     pulumi.String("string"),
    	AppEngineIntegrationMode: pulumi.String("string"),
    	CmekConfig: &firestore.DatabaseCmekConfigArgs{
    		KmsKeyName: pulumi.String("string"),
    		ActiveKeyVersions: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	ConcurrencyMode:               pulumi.String("string"),
    	DeleteProtectionState:         pulumi.String("string"),
    	DeletionPolicy:                pulumi.String("string"),
    	Name:                          pulumi.String("string"),
    	PointInTimeRecoveryEnablement: pulumi.String("string"),
    	Project:                       pulumi.String("string"),
    })
    
    var gcpDatabaseResource = new Database("gcpDatabaseResource", DatabaseArgs.builder()
        .locationId("string")
        .type("string")
        .appEngineIntegrationMode("string")
        .cmekConfig(DatabaseCmekConfigArgs.builder()
            .kmsKeyName("string")
            .activeKeyVersions("string")
            .build())
        .concurrencyMode("string")
        .deleteProtectionState("string")
        .deletionPolicy("string")
        .name("string")
        .pointInTimeRecoveryEnablement("string")
        .project("string")
        .build());
    
    gcp_database_resource = gcp.firestore.Database("gcpDatabaseResource",
        location_id="string",
        type="string",
        app_engine_integration_mode="string",
        cmek_config=gcp.firestore.DatabaseCmekConfigArgs(
            kms_key_name="string",
            active_key_versions=["string"],
        ),
        concurrency_mode="string",
        delete_protection_state="string",
        deletion_policy="string",
        name="string",
        point_in_time_recovery_enablement="string",
        project="string")
    
    const gcpDatabaseResource = new gcp.firestore.Database("gcpDatabaseResource", {
        locationId: "string",
        type: "string",
        appEngineIntegrationMode: "string",
        cmekConfig: {
            kmsKeyName: "string",
            activeKeyVersions: ["string"],
        },
        concurrencyMode: "string",
        deleteProtectionState: "string",
        deletionPolicy: "string",
        name: "string",
        pointInTimeRecoveryEnablement: "string",
        project: "string",
    });
    
    type: gcp:firestore:Database
    properties:
        appEngineIntegrationMode: string
        cmekConfig:
            activeKeyVersions:
                - string
            kmsKeyName: string
        concurrencyMode: string
        deleteProtectionState: string
        deletionPolicy: string
        locationId: string
        name: string
        pointInTimeRecoveryEnablement: string
        project: string
        type: string
    

    Database 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 Database resource accepts the following input properties:

    LocationId string
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    Type string
    The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    AppEngineIntegrationMode string
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    CmekConfig DatabaseCmekConfig
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    ConcurrencyMode string
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    DeleteProtectionState string
    DeletionPolicy string
    Name string
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    PointInTimeRecoveryEnablement string
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    LocationId string
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    Type string
    The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    AppEngineIntegrationMode string
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    CmekConfig DatabaseCmekConfigArgs
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    ConcurrencyMode string
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    DeleteProtectionState string
    DeletionPolicy string
    Name string
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    PointInTimeRecoveryEnablement string
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    locationId String
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    type String
    The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    appEngineIntegrationMode String
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    cmekConfig DatabaseCmekConfig
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    concurrencyMode String
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    deleteProtectionState String
    deletionPolicy String
    name String
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    pointInTimeRecoveryEnablement String
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    locationId string
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    type string
    The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    appEngineIntegrationMode string
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    cmekConfig DatabaseCmekConfig
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    concurrencyMode string
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    deleteProtectionState string
    deletionPolicy string
    name string
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    pointInTimeRecoveryEnablement string
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location_id str
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    type str
    The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    app_engine_integration_mode str
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    cmek_config DatabaseCmekConfigArgs
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    concurrency_mode str
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    delete_protection_state str
    deletion_policy str
    name str
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    point_in_time_recovery_enablement str
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    locationId String
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    type String
    The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    appEngineIntegrationMode String
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    cmekConfig Property Map
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    concurrencyMode String
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    deleteProtectionState String
    deletionPolicy String
    name String
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    pointInTimeRecoveryEnablement String
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

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

    CreateTime string
    Output only. The timestamp at which this database was created.
    EarliestVersionTime string
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Etag string
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyPrefix string
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    Uid string
    Output only. The system-generated UUID4 for this Database.
    UpdateTime string
    Output only. The timestamp at which this database was most recently updated.
    VersionRetentionPeriod string
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    CreateTime string
    Output only. The timestamp at which this database was created.
    EarliestVersionTime string
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Etag string
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyPrefix string
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    Uid string
    Output only. The system-generated UUID4 for this Database.
    UpdateTime string
    Output only. The timestamp at which this database was most recently updated.
    VersionRetentionPeriod string
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    createTime String
    Output only. The timestamp at which this database was created.
    earliestVersionTime String
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    etag String
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    id String
    The provider-assigned unique ID for this managed resource.
    keyPrefix String
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    uid String
    Output only. The system-generated UUID4 for this Database.
    updateTime String
    Output only. The timestamp at which this database was most recently updated.
    versionRetentionPeriod String
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    createTime string
    Output only. The timestamp at which this database was created.
    earliestVersionTime string
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    etag string
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    id string
    The provider-assigned unique ID for this managed resource.
    keyPrefix string
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    uid string
    Output only. The system-generated UUID4 for this Database.
    updateTime string
    Output only. The timestamp at which this database was most recently updated.
    versionRetentionPeriod string
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    create_time str
    Output only. The timestamp at which this database was created.
    earliest_version_time str
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    etag str
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    id str
    The provider-assigned unique ID for this managed resource.
    key_prefix str
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    uid str
    Output only. The system-generated UUID4 for this Database.
    update_time str
    Output only. The timestamp at which this database was most recently updated.
    version_retention_period str
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    createTime String
    Output only. The timestamp at which this database was created.
    earliestVersionTime String
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    etag String
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    id String
    The provider-assigned unique ID for this managed resource.
    keyPrefix String
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    uid String
    Output only. The system-generated UUID4 for this Database.
    updateTime String
    Output only. The timestamp at which this database was most recently updated.
    versionRetentionPeriod String
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

    Look up Existing Database Resource

    Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_engine_integration_mode: Optional[str] = None,
            cmek_config: Optional[DatabaseCmekConfigArgs] = None,
            concurrency_mode: Optional[str] = None,
            create_time: Optional[str] = None,
            delete_protection_state: Optional[str] = None,
            deletion_policy: Optional[str] = None,
            earliest_version_time: Optional[str] = None,
            etag: Optional[str] = None,
            key_prefix: Optional[str] = None,
            location_id: Optional[str] = None,
            name: Optional[str] = None,
            point_in_time_recovery_enablement: Optional[str] = None,
            project: Optional[str] = None,
            type: Optional[str] = None,
            uid: Optional[str] = None,
            update_time: Optional[str] = None,
            version_retention_period: Optional[str] = None) -> Database
    func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
    public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
    public static Database get(String name, Output<String> id, DatabaseState 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:
    AppEngineIntegrationMode string
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    CmekConfig DatabaseCmekConfig
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    ConcurrencyMode string
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    CreateTime string
    Output only. The timestamp at which this database was created.
    DeleteProtectionState string
    DeletionPolicy string
    EarliestVersionTime string
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Etag string
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    KeyPrefix string
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    LocationId string
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    Name string
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    PointInTimeRecoveryEnablement string
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    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 type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    Uid string
    Output only. The system-generated UUID4 for this Database.
    UpdateTime string
    Output only. The timestamp at which this database was most recently updated.
    VersionRetentionPeriod string
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    AppEngineIntegrationMode string
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    CmekConfig DatabaseCmekConfigArgs
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    ConcurrencyMode string
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    CreateTime string
    Output only. The timestamp at which this database was created.
    DeleteProtectionState string
    DeletionPolicy string
    EarliestVersionTime string
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Etag string
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    KeyPrefix string
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    LocationId string
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    Name string
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    PointInTimeRecoveryEnablement string
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    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 type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    Uid string
    Output only. The system-generated UUID4 for this Database.
    UpdateTime string
    Output only. The timestamp at which this database was most recently updated.
    VersionRetentionPeriod string
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    appEngineIntegrationMode String
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    cmekConfig DatabaseCmekConfig
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    concurrencyMode String
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    createTime String
    Output only. The timestamp at which this database was created.
    deleteProtectionState String
    deletionPolicy String
    earliestVersionTime String
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    etag String
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    keyPrefix String
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    locationId String
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    name String
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    pointInTimeRecoveryEnablement String
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    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 type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    uid String
    Output only. The system-generated UUID4 for this Database.
    updateTime String
    Output only. The timestamp at which this database was most recently updated.
    versionRetentionPeriod String
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    appEngineIntegrationMode string
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    cmekConfig DatabaseCmekConfig
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    concurrencyMode string
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    createTime string
    Output only. The timestamp at which this database was created.
    deleteProtectionState string
    deletionPolicy string
    earliestVersionTime string
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    etag string
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    keyPrefix string
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    locationId string
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    name string
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    pointInTimeRecoveryEnablement string
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    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 type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    uid string
    Output only. The system-generated UUID4 for this Database.
    updateTime string
    Output only. The timestamp at which this database was most recently updated.
    versionRetentionPeriod string
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    app_engine_integration_mode str
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    cmek_config DatabaseCmekConfigArgs
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    concurrency_mode str
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    create_time str
    Output only. The timestamp at which this database was created.
    delete_protection_state str
    deletion_policy str
    earliest_version_time str
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    etag str
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    key_prefix str
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    location_id str
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    name str
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    point_in_time_recovery_enablement str
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    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 type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    uid str
    Output only. The system-generated UUID4 for this Database.
    update_time str
    Output only. The timestamp at which this database was most recently updated.
    version_retention_period str
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
    appEngineIntegrationMode String
    The App Engine integration mode to use for this database. Possible values are: ENABLED, DISABLED.
    cmekConfig Property Map
    The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.
    concurrencyMode String
    The concurrency control mode to use for this database. Possible values are: OPTIMISTIC, PESSIMISTIC, OPTIMISTIC_WITH_ENTITY_GROUPS.
    createTime String
    Output only. The timestamp at which this database was created.
    deleteProtectionState String
    deletionPolicy String
    earliestVersionTime String
    Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    etag String
    Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    keyPrefix String
    Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
    locationId String
    The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
    name String
    The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
    pointInTimeRecoveryEnablement String
    Whether to enable the PITR feature on this database. If POINT_IN_TIME_RECOVERY_ENABLED is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If POINT_IN_TIME_RECOVERY_DISABLED is selected, reads are supported on any version of the data from within the past 1 hour. Default value is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.
    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 type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values are: FIRESTORE_NATIVE, DATASTORE_MODE.


    uid String
    Output only. The system-generated UUID4 for this Database.
    updateTime String
    Output only. The timestamp at which this database was most recently updated.
    versionRetentionPeriod String
    Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

    Supporting Types

    DatabaseCmekConfig, DatabaseCmekConfigArgs

    KmsKeyName string
    The resource ID of a Cloud KMS key. If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. This value should be the KMS key resource ID in the format of projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. How to retrive this resource ID is listed at https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version.
    ActiveKeyVersions List<string>
    (Output) Currently in-use KMS key versions (https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During key rotation (https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
    KmsKeyName string
    The resource ID of a Cloud KMS key. If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. This value should be the KMS key resource ID in the format of projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. How to retrive this resource ID is listed at https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version.
    ActiveKeyVersions []string
    (Output) Currently in-use KMS key versions (https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During key rotation (https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
    kmsKeyName String
    The resource ID of a Cloud KMS key. If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. This value should be the KMS key resource ID in the format of projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. How to retrive this resource ID is listed at https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version.
    activeKeyVersions List<String>
    (Output) Currently in-use KMS key versions (https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During key rotation (https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
    kmsKeyName string
    The resource ID of a Cloud KMS key. If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. This value should be the KMS key resource ID in the format of projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. How to retrive this resource ID is listed at https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version.
    activeKeyVersions string[]
    (Output) Currently in-use KMS key versions (https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During key rotation (https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
    kms_key_name str
    The resource ID of a Cloud KMS key. If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. This value should be the KMS key resource ID in the format of projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. How to retrive this resource ID is listed at https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version.
    active_key_versions Sequence[str]
    (Output) Currently in-use KMS key versions (https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During key rotation (https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
    kmsKeyName String
    The resource ID of a Cloud KMS key. If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. This value should be the KMS key resource ID in the format of projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. How to retrive this resource ID is listed at https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version.
    activeKeyVersions List<String>
    (Output) Currently in-use KMS key versions (https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During key rotation (https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

    Import

    Database can be imported using any of these accepted formats:

    • projects/{{project}}/databases/{{name}}

    • {{project}}/{{name}}

    • {{name}}

    When using the pulumi import command, Database can be imported using one of the formats above. For example:

    $ pulumi import gcp:firestore/database:Database default projects/{{project}}/databases/{{name}}
    
    $ pulumi import gcp:firestore/database:Database default {{project}}/{{name}}
    
    $ pulumi import gcp:firestore/database:Database default {{name}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.
    gcp logo
    Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi