@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
155 lines • 6.43 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.ServerlessDatabase = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* The `scaleway.databases.ServerlessDatabase` resource allows you to create and manage databases for Scaleway Serverless SQL Databases.
*
* Refer to the Serverless SQL Databases [documentation](https://www.scaleway.com/en/docs/serverless-sql-databases/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-databases/) for more information.
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const database = new scaleway.databases.ServerlessDatabase("database", {
* name: "my-database",
* minCpu: 0,
* maxCpu: 8,
* });
* ```
*
* ### With IAM Application
*
* This example creates an [IAM application](https://www.scaleway.com/en/docs/iam/concepts/#application) and an [API secret key](https://www.scaleway.com/en/docs/iam/how-to/create-api-keys/) used to connect to the database.
*
* > **Note:** For more information, see [How to connect to a Serverless SQL Database](https://www.scaleway.com/en/docs/serverless-sql-databases/how-to/connect-to-a-database/)
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
* import * as std from "@pulumi/std";
*
* const _default = scaleway.account.getProject({
* name: "default",
* });
* const app = new scaleway.iam.Application("app", {name: "my app"});
* const dbAccess = new scaleway.iam.Policy("db_access", {
* name: "my policy",
* description: "gives app access to serverless database in project",
* applicationId: app.id,
* rules: [{
* projectIds: [_default.then(_default => _default.id)],
* permissionSetNames: ["ServerlessSQLDatabaseReadWrite"],
* }],
* });
* const apiKey = new scaleway.iam.ApiKey("api_key", {applicationId: app.id});
* const database = new scaleway.databases.ServerlessDatabase("database", {
* name: "my-database",
* minCpu: 0,
* maxCpu: 8,
* });
* export const databaseConnectionString = std.format({
* input: "postgres://%s:%s@%s",
* args: [
* app.id,
* apiKey.secretKey,
* std.trimprefix({
* input: database.endpoint,
* prefix: "postgres://",
* }).result,
* ],
* }).result;
* ```
*
* ## Import
*
* Serverless SQL Databases can be imported using the `{region}/{id}`, as shown below:
*
* ```sh
* $ pulumi import scaleway:databases/serverlessDatabase:ServerlessDatabase database fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
class ServerlessDatabase extends pulumi.CustomResource {
/**
* Get an existing ServerlessDatabase 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 ServerlessDatabase(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'scaleway:databases/serverlessDatabase:ServerlessDatabase';
/**
* Returns true if the given object is an instance of ServerlessDatabase. 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'] === ServerlessDatabase.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["endpoint"] = state?.endpoint;
resourceInputs["maxCpu"] = state?.maxCpu;
resourceInputs["minCpu"] = state?.minCpu;
resourceInputs["name"] = state?.name;
resourceInputs["projectId"] = state?.projectId;
resourceInputs["region"] = state?.region;
}
else {
const args = argsOrState;
resourceInputs["maxCpu"] = args?.maxCpu;
resourceInputs["minCpu"] = args?.minCpu;
resourceInputs["name"] = args?.name;
resourceInputs["projectId"] = args?.projectId;
resourceInputs["region"] = args?.region;
resourceInputs["endpoint"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "scaleway:index/sdbDatabase:SdbDatabase" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(ServerlessDatabase.__pulumiType, name, resourceInputs, opts);
}
}
exports.ServerlessDatabase = ServerlessDatabase;
//# sourceMappingURL=serverlessDatabase.js.map