@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
255 lines • 10.2 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! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.DatabaseCluster = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Provides a DigitalOcean database cluster resource.
*
* ## Example Usage
*
* ### Create a new PostgreSQL database cluster
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const postgres_example = new digitalocean.DatabaseCluster("postgres-example", {
* name: "example-postgres-cluster",
* engine: "pg",
* version: "15",
* size: digitalocean.DatabaseSlug.DB_1VPCU1GB,
* region: digitalocean.Region.NYC1,
* nodeCount: 1,
* });
* ```
*
* ### Create a new MySQL database cluster
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const mysql_example = new digitalocean.DatabaseCluster("mysql-example", {
* name: "example-mysql-cluster",
* engine: "mysql",
* version: "8",
* size: digitalocean.DatabaseSlug.DB_1VPCU1GB,
* region: digitalocean.Region.NYC1,
* nodeCount: 1,
* });
* ```
*
* ### Create a new Valkey database cluster
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const valkey_example = new digitalocean.DatabaseCluster("valkey-example", {
* name: "example-valkey-cluster",
* engine: "valkey",
* version: "8",
* size: digitalocean.DatabaseSlug.DB_1VPCU1GB,
* region: digitalocean.Region.NYC1,
* nodeCount: 1,
* });
* ```
*
* ### Create a new Kafka database cluster
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const kafka_example = new digitalocean.DatabaseCluster("kafka-example", {
* name: "example-kafka-cluster",
* engine: "kafka",
* version: "3.5",
* size: "db-s-2vcpu-2gb",
* region: digitalocean.Region.NYC1,
* nodeCount: 3,
* });
* ```
*
* ### Create a new MongoDB database cluster
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const mongodb_example = new digitalocean.DatabaseCluster("mongodb-example", {
* name: "example-mongo-cluster",
* engine: "mongodb",
* version: "6",
* size: digitalocean.DatabaseSlug.DB_1VPCU1GB,
* region: digitalocean.Region.NYC3,
* nodeCount: 1,
* });
* ```
*
* ### Create a new OpenSearch database cluster
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const opensearch_example = new digitalocean.DatabaseCluster("opensearch-example", {
* name: "example-opensearch-cluster",
* engine: "opensearch",
* version: "2",
* size: digitalocean.DatabaseSlug.DB_1VPCU2GB,
* region: digitalocean.Region.NYC3,
* nodeCount: 1,
* });
* ```
*
* ## Create a new database cluster based on a backup of an existing cluster.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const doby = new digitalocean.DatabaseCluster("doby", {
* name: "dobydb",
* engine: "pg",
* version: "15",
* size: digitalocean.DatabaseSlug.DB_1VPCU2GB,
* region: digitalocean.Region.NYC1,
* nodeCount: 1,
* tags: ["production"],
* });
* const dobyBackup = new digitalocean.DatabaseCluster("doby_backup", {
* name: "dobydupe",
* engine: "pg",
* version: "15",
* size: digitalocean.DatabaseSlug.DB_1VPCU2GB,
* region: digitalocean.Region.NYC1,
* nodeCount: 1,
* tags: ["production"],
* backupRestore: {
* databaseName: "dobydb",
* },
* }, {
* dependsOn: [doby],
* });
* ```
*
* ## Import
*
* Database clusters can be imported using the `id` returned from DigitalOcean, e.g.
*
* ```sh
* $ pulumi import digitalocean:index/databaseCluster:DatabaseCluster mycluster 245bcfd0-7f31-4ce6-a2bc-475a116cca97
* ```
*/
class DatabaseCluster extends pulumi.CustomResource {
/**
* Get an existing DatabaseCluster 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 DatabaseCluster(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DatabaseCluster. 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'] === DatabaseCluster.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["backupRestore"] = state?.backupRestore;
resourceInputs["clusterUrn"] = state?.clusterUrn;
resourceInputs["database"] = state?.database;
resourceInputs["engine"] = state?.engine;
resourceInputs["evictionPolicy"] = state?.evictionPolicy;
resourceInputs["host"] = state?.host;
resourceInputs["maintenanceWindows"] = state?.maintenanceWindows;
resourceInputs["metricsEndpoints"] = state?.metricsEndpoints;
resourceInputs["name"] = state?.name;
resourceInputs["nodeCount"] = state?.nodeCount;
resourceInputs["password"] = state?.password;
resourceInputs["port"] = state?.port;
resourceInputs["privateHost"] = state?.privateHost;
resourceInputs["privateNetworkUuid"] = state?.privateNetworkUuid;
resourceInputs["privateUri"] = state?.privateUri;
resourceInputs["projectId"] = state?.projectId;
resourceInputs["region"] = state?.region;
resourceInputs["size"] = state?.size;
resourceInputs["sqlMode"] = state?.sqlMode;
resourceInputs["storageSizeMib"] = state?.storageSizeMib;
resourceInputs["tags"] = state?.tags;
resourceInputs["uiDatabase"] = state?.uiDatabase;
resourceInputs["uiHost"] = state?.uiHost;
resourceInputs["uiPassword"] = state?.uiPassword;
resourceInputs["uiPort"] = state?.uiPort;
resourceInputs["uiUri"] = state?.uiUri;
resourceInputs["uiUser"] = state?.uiUser;
resourceInputs["uri"] = state?.uri;
resourceInputs["user"] = state?.user;
resourceInputs["version"] = state?.version;
}
else {
const args = argsOrState;
if (args?.engine === undefined && !opts.urn) {
throw new Error("Missing required property 'engine'");
}
if (args?.nodeCount === undefined && !opts.urn) {
throw new Error("Missing required property 'nodeCount'");
}
if (args?.region === undefined && !opts.urn) {
throw new Error("Missing required property 'region'");
}
if (args?.size === undefined && !opts.urn) {
throw new Error("Missing required property 'size'");
}
resourceInputs["backupRestore"] = args?.backupRestore;
resourceInputs["engine"] = args?.engine;
resourceInputs["evictionPolicy"] = args?.evictionPolicy;
resourceInputs["maintenanceWindows"] = args?.maintenanceWindows;
resourceInputs["name"] = args?.name;
resourceInputs["nodeCount"] = args?.nodeCount;
resourceInputs["privateNetworkUuid"] = args?.privateNetworkUuid;
resourceInputs["projectId"] = args?.projectId;
resourceInputs["region"] = args?.region;
resourceInputs["size"] = args?.size;
resourceInputs["sqlMode"] = args?.sqlMode;
resourceInputs["storageSizeMib"] = args?.storageSizeMib;
resourceInputs["tags"] = args?.tags;
resourceInputs["version"] = args?.version;
resourceInputs["clusterUrn"] = undefined /*out*/;
resourceInputs["database"] = undefined /*out*/;
resourceInputs["host"] = undefined /*out*/;
resourceInputs["metricsEndpoints"] = undefined /*out*/;
resourceInputs["password"] = undefined /*out*/;
resourceInputs["port"] = undefined /*out*/;
resourceInputs["privateHost"] = undefined /*out*/;
resourceInputs["privateUri"] = undefined /*out*/;
resourceInputs["uiDatabase"] = undefined /*out*/;
resourceInputs["uiHost"] = undefined /*out*/;
resourceInputs["uiPassword"] = undefined /*out*/;
resourceInputs["uiPort"] = undefined /*out*/;
resourceInputs["uiUri"] = undefined /*out*/;
resourceInputs["uiUser"] = undefined /*out*/;
resourceInputs["uri"] = undefined /*out*/;
resourceInputs["user"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["password", "privateUri", "uiPassword", "uiUri", "uri"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(DatabaseCluster.__pulumiType, name, resourceInputs, opts);
}
}
exports.DatabaseCluster = DatabaseCluster;
/** @internal */
DatabaseCluster.__pulumiType = 'digitalocean:index/databaseCluster:DatabaseCluster';
//# sourceMappingURL=databaseCluster.js.map