@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
342 lines • 13.7 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Database = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* 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",
* });
* ```
* ### 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",
* });
* ```
* ### Firestore Database With Tags
*
* ```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-with-tags-id",
* locationId: "nam5",
* type: "FIRESTORE_NATIVE",
* deleteProtectionState: "DELETE_PROTECTION_ENABLED",
* deletionPolicy: "DELETE",
* tags: {
* keyname: "valuename",
* },
* });
* ```
* ### 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 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],
* });
* ```
* ### 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",
* });
* ```
* ### 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",
* });
* ```
* ### 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 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],
* });
* ```
* ### Firestore Database Enterprise
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const enterprise_db = new gcp.firestore.Database("enterprise-db", {
* project: "my-project-name",
* name: "database-id",
* locationId: "nam5",
* type: "FIRESTORE_NATIVE",
* databaseEdition: "ENTERPRISE",
* deletionPolicy: "DELETE",
* });
* ```
* ### Firestore Database Data Access
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const firestoreAccessDatabase = new gcp.firestore.Database("firestore_access_database", {
* project: "my-project-name",
* name: "data-access-database-id",
* locationId: "nam5",
* type: "FIRESTORE_NATIVE",
* databaseEdition: "ENTERPRISE",
* firestoreDataAccessMode: "DATA_ACCESS_MODE_ENABLED",
* mongodbCompatibleDataAccessMode: "DATA_ACCESS_MODE_DISABLED",
* realtimeUpdatesMode: "REALTIME_UPDATES_MODE_DISABLED",
* });
* ```
*
* ## 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}}
* $ pulumi import gcp:firestore/database:Database default {{project}}/{{name}}
* $ pulumi import gcp:firestore/database:Database default {{name}}
* ```
*/
class Database extends pulumi.CustomResource {
/**
* Get an existing Database resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new Database(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:firestore/database:Database';
/**
* Returns true if the given object is an instance of Database. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Database.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["appEngineIntegrationMode"] = state?.appEngineIntegrationMode;
resourceInputs["cmekConfig"] = state?.cmekConfig;
resourceInputs["concurrencyMode"] = state?.concurrencyMode;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["databaseEdition"] = state?.databaseEdition;
resourceInputs["deleteProtectionState"] = state?.deleteProtectionState;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["earliestVersionTime"] = state?.earliestVersionTime;
resourceInputs["etag"] = state?.etag;
resourceInputs["firestoreDataAccessMode"] = state?.firestoreDataAccessMode;
resourceInputs["keyPrefix"] = state?.keyPrefix;
resourceInputs["locationId"] = state?.locationId;
resourceInputs["mongodbCompatibleDataAccessMode"] = state?.mongodbCompatibleDataAccessMode;
resourceInputs["name"] = state?.name;
resourceInputs["pointInTimeRecoveryEnablement"] = state?.pointInTimeRecoveryEnablement;
resourceInputs["project"] = state?.project;
resourceInputs["realtimeUpdatesMode"] = state?.realtimeUpdatesMode;
resourceInputs["tags"] = state?.tags;
resourceInputs["type"] = state?.type;
resourceInputs["uid"] = state?.uid;
resourceInputs["updateTime"] = state?.updateTime;
resourceInputs["versionRetentionPeriod"] = state?.versionRetentionPeriod;
}
else {
const args = argsOrState;
if (args?.locationId === undefined && !opts.urn) {
throw new Error("Missing required property 'locationId'");
}
if (args?.type === undefined && !opts.urn) {
throw new Error("Missing required property 'type'");
}
resourceInputs["appEngineIntegrationMode"] = args?.appEngineIntegrationMode;
resourceInputs["cmekConfig"] = args?.cmekConfig;
resourceInputs["concurrencyMode"] = args?.concurrencyMode;
resourceInputs["databaseEdition"] = args?.databaseEdition;
resourceInputs["deleteProtectionState"] = args?.deleteProtectionState;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["firestoreDataAccessMode"] = args?.firestoreDataAccessMode;
resourceInputs["locationId"] = args?.locationId;
resourceInputs["mongodbCompatibleDataAccessMode"] = args?.mongodbCompatibleDataAccessMode;
resourceInputs["name"] = args?.name;
resourceInputs["pointInTimeRecoveryEnablement"] = args?.pointInTimeRecoveryEnablement;
resourceInputs["project"] = args?.project;
resourceInputs["realtimeUpdatesMode"] = args?.realtimeUpdatesMode;
resourceInputs["tags"] = args?.tags;
resourceInputs["type"] = args?.type;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["earliestVersionTime"] = undefined /*out*/;
resourceInputs["etag"] = undefined /*out*/;
resourceInputs["keyPrefix"] = undefined /*out*/;
resourceInputs["uid"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
resourceInputs["versionRetentionPeriod"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Database.__pulumiType, name, resourceInputs, opts);
}
}
exports.Database = Database;
//# sourceMappingURL=database.js.map