@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
192 lines • 7.85 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.DatabaseUser = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("./utilities"));
/**
* Provides a DigitalOcean database user resource. When creating a new database cluster, a default admin user with name `doadmin` will be created. Then, this resource can be used to provide additional normal users inside the cluster.
*
* > **NOTE:** Any new users created will always have `normal` role, only the default user that comes with database cluster creation has `primary` role. Additional permissions must be managed manually.
*
* ## Example Usage
*
* ### Create a new PostgreSQL database user
* ```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,
* });
* const user_example = new digitalocean.DatabaseUser("user-example", {
* clusterId: postgres_example.id,
* name: "foobar",
* });
* ```
*
* ### Create a new user for a PostgreSQL database replica
* ```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,
* });
* const replica_example = new digitalocean.DatabaseReplica("replica-example", {
* clusterId: postgres_example.id,
* name: "replica-example",
* size: digitalocean.DatabaseSlug.DB_1VPCU1GB,
* region: digitalocean.Region.NYC1,
* });
* const user_example = new digitalocean.DatabaseUser("user-example", {
* clusterId: replica_example.uuid,
* name: "foobar",
* });
* ```
*
* ### Create a new user for a 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,
* });
* const foobarTopic = new digitalocean.DatabaseKafkaTopic("foobar_topic", {
* clusterId: foobar.id,
* name: "topic-1",
* });
* const foobarUser = new digitalocean.DatabaseUser("foobar_user", {
* clusterId: foobar.id,
* name: "example-user",
* settings: [{
* acls: [
* {
* topic: "topic-1",
* permission: "produce",
* },
* {
* topic: "topic-2",
* permission: "produceconsume",
* },
* {
* topic: "topic-*",
* permission: "consume",
* },
* ],
* }],
* });
* ```
*
* ## Import
*
* Database user can be imported using the `id` of the source database cluster
* and the `name` of the user joined with a comma. For example:
*
* ```sh
* $ pulumi import digitalocean:index/databaseUser:DatabaseUser user-example 245bcfd0-7f31-4ce6-a2bc-475a116cca97,foobar
* ```
*
* > **Note:** MongoDB user passwords are only available when the user is created. An existing MongoDB user that is imported will not have its `password` attribute exported. Recreate the user if it is necessary to access the password with Terraform.
*/
class DatabaseUser extends pulumi.CustomResource {
/**
* Get an existing DatabaseUser 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 DatabaseUser(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'digitalocean:index/databaseUser:DatabaseUser';
/**
* Returns true if the given object is an instance of DatabaseUser. 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'] === DatabaseUser.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["accessCert"] = state?.accessCert;
resourceInputs["accessKey"] = state?.accessKey;
resourceInputs["clusterId"] = state?.clusterId;
resourceInputs["mysqlAuthPlugin"] = state?.mysqlAuthPlugin;
resourceInputs["name"] = state?.name;
resourceInputs["password"] = state?.password;
resourceInputs["role"] = state?.role;
resourceInputs["settings"] = state?.settings;
}
else {
const args = argsOrState;
if (args?.clusterId === undefined && !opts.urn) {
throw new Error("Missing required property 'clusterId'");
}
resourceInputs["clusterId"] = args?.clusterId;
resourceInputs["mysqlAuthPlugin"] = args?.mysqlAuthPlugin;
resourceInputs["name"] = args?.name;
resourceInputs["settings"] = args?.settings;
resourceInputs["accessCert"] = undefined /*out*/;
resourceInputs["accessKey"] = undefined /*out*/;
resourceInputs["password"] = undefined /*out*/;
resourceInputs["role"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["accessCert", "accessKey", "password"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(DatabaseUser.__pulumiType, name, resourceInputs, opts);
}
}
exports.DatabaseUser = DatabaseUser;
//# sourceMappingURL=databaseUser.js.map