com.pulumi.gcp.firestore.kotlin.Database.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.firestore.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.firestore.kotlin.outputs.DatabaseCmekConfig
import com.pulumi.gcp.firestore.kotlin.outputs.DatabaseCmekConfig.Companion.toKotlin
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [Database].
*/
@PulumiTagMarker
public class DatabaseResourceBuilder internal constructor() {
public var name: String? = null
public var args: DatabaseArgs = DatabaseArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend DatabaseArgsBuilder.() -> Unit) {
val builder = DatabaseArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Database {
val builtJavaResource = com.pulumi.gcp.firestore.Database(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Database(builtJavaResource)
}
}
/**
* 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](https://cloud.google.com/firestore/docs/app-engine-requirement).
* To get more information about Database, see:
* * [API documentation](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/firestore/docs/)
* ## Example Usage
* ### Firestore Default Database
*
* ```typescript
* 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",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* database = gcp.firestore.Database("database",
* project="my-project-name",
* name="(default)",
* location_id="nam5",
* type="FIRESTORE_NATIVE")
* ```
* ```csharp
* 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",
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* resources:
* database:
* type: gcp:firestore:Database
* properties:
* project: my-project-name
* name: (default)
* locationId: nam5
* type: FIRESTORE_NATIVE
* ```
*
* ### Firestore Database
*
* ```typescript
* 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",
* });
* ```
* ```python
* 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")
* ```
* ```csharp
* 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",
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
*
* ```typescript
* 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 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,
* },
* });
* 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`)],
* });
* ```
* ```python
* 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")
* 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,
* ))
* 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"])
* ```
* ```csharp
* 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 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,
* },
* });
* 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",
* },
* });
* });
* ```
* ```go
* 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
* }
* _, 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(),
* },
* })
* if err != nil {
* return err
* }
* _, 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-%[email protected]", project.Number)),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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.firestore.Database;
* import com.pulumi.gcp.firestore.DatabaseArgs;
* import com.pulumi.gcp.firestore.inputs.DatabaseCmekConfigArgs;
* import com.pulumi.gcp.kms.CryptoKeyIAMBinding;
* import com.pulumi.gcp.kms.CryptoKeyIAMBindingArgs;
* 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 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());
* var firestoreCmekKeyuser = new CryptoKeyIAMBinding("firestoreCmekKeyuser", CryptoKeyIAMBindingArgs.builder()
* .cryptoKeyId(cryptoKey.id())
* .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
* .members(String.format("serviceAccount:service-%[email protected]", project.applyValue(getProjectResult -> getProjectResult.number())))
* .build());
* }
* }
* ```
* ```yaml
* 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}
* 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
*
* ```typescript
* 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",
* });
* ```
* ```python
* 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")
* ```
* ```csharp
* 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",
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
*
* ```typescript
* 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",
* });
* ```
* ```python
* 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")
* ```
* ```csharp
* 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",
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
*
* ```typescript
* 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 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,
* },
* });
* 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`)],
* });
* ```
* ```python
* 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")
* 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,
* ))
* 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"])
* ```
* ```csharp
* 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 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,
* },
* });
* 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",
* },
* });
* });
* ```
* ```go
* 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
* }
* _, 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(),
* },
* })
* if err != nil {
* return err
* }
* _, 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-%[email protected]", project.Number)),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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.firestore.Database;
* import com.pulumi.gcp.firestore.DatabaseArgs;
* import com.pulumi.gcp.firestore.inputs.DatabaseCmekConfigArgs;
* import com.pulumi.gcp.kms.CryptoKeyIAMBinding;
* import com.pulumi.gcp.kms.CryptoKeyIAMBindingArgs;
* 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 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());
* var firestoreCmekKeyuser = new CryptoKeyIAMBinding("firestoreCmekKeyuser", CryptoKeyIAMBindingArgs.builder()
* .cryptoKeyId(cryptoKey.id())
* .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
* .members(String.format("serviceAccount:service-%[email protected]", project.applyValue(getProjectResult -> getProjectResult.number())))
* .build());
* }
* }
* ```
* ```yaml
* 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}
* 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: {}
* ```
*
* ## 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:
* ```sh
* $ pulumi import gcp:firestore/database:Database default projects/{{project}}/databases/{{name}}
* ```
* ```sh
* $ pulumi import gcp:firestore/database:Database default {{project}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:firestore/database:Database default {{name}}
* ```
*/
public class Database internal constructor(
override val javaResource: com.pulumi.gcp.firestore.Database,
) : KotlinCustomResource(javaResource, DatabaseMapper) {
/**
* The App Engine integration mode to use for this database.
* Possible values are: `ENABLED`, `DISABLED`.
*/
public val appEngineIntegrationMode: Output
get() = javaResource.appEngineIntegrationMode().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val cmekConfig: Output?
get() = javaResource.cmekConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
toKotlin(args0)
})
}).orElse(null)
})
/**
* The concurrency control mode to use for this database.
* Possible values are: `OPTIMISTIC`, `PESSIMISTIC`, `OPTIMISTIC_WITH_ENTITY_GROUPS`.
*/
public val concurrencyMode: Output
get() = javaResource.concurrencyMode().applyValue({ args0 -> args0 })
/**
* Output only. The timestamp at which this database was created.
*/
public val createTime: Output
get() = javaResource.createTime().applyValue({ args0 -> args0 })
public val deleteProtectionState: Output
get() = javaResource.deleteProtectionState().applyValue({ args0 -> args0 })
public val deletionPolicy: Output?
get() = javaResource.deletionPolicy().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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".
*/
public val earliestVersionTime: Output
get() = javaResource.earliestVersionTime().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val etag: Output
get() = javaResource.etag().applyValue({ args0 -> args0 })
/**
* 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).
*/
public val keyPrefix: Output
get() = javaResource.keyPrefix().applyValue({ args0 -> args0 })
/**
* The location of the database. Available locations are listed at
* https://cloud.google.com/firestore/docs/locations.
*/
public val locationId: Output
get() = javaResource.locationId().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* 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`.
*/
public val pointInTimeRecoveryEnablement: Output?
get() = javaResource.pointInTimeRecoveryEnablement().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* 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`.
* - - -
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
/**
* Output only. The system-generated UUID4 for this Database.
*/
public val uid: Output
get() = javaResource.uid().applyValue({ args0 -> args0 })
/**
* Output only. The timestamp at which this database was most recently updated.
*/
public val updateTime: Output
get() = javaResource.updateTime().applyValue({ args0 -> args0 })
/**
* 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".
*/
public val versionRetentionPeriod: Output
get() = javaResource.versionRetentionPeriod().applyValue({ args0 -> args0 })
}
public object DatabaseMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.firestore.Database::class == javaResource::class
override fun map(javaResource: Resource): Database = Database(
javaResource as
com.pulumi.gcp.firestore.Database,
)
}
/**
* @see [Database].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Database].
*/
public suspend fun database(name: String, block: suspend DatabaseResourceBuilder.() -> Unit): Database {
val builder = DatabaseResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Database].
* @param name The _unique_ name of the resulting resource.
*/
public fun database(name: String): Database {
val builder = DatabaseResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy