UNPKG

@pulumiverse/scaleway

Version:

A Pulumi package for creating and managing Scaleway cloud resources.

143 lines (142 loc) 4.58 kB
import * as pulumi from "@pulumi/pulumi"; /** * Creates and manages databases. * For more information, refer to the [API documentation](https://www.scaleway.com/en/developers/api/managed-database-postgre-mysql/). * * ## Example Usage * * ### Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * * const main = new scaleway.databases.Instance("main", { * name: "test-rdb", * nodeType: "DB-DEV-S", * engine: "PostgreSQL-15", * isHaCluster: true, * disableBackup: true, * userName: "my_initial_user", * password: "thiZ_is_v&ry_s3cret", * }); * const mainDatabase = new scaleway.databases.Database("main", { * instanceId: main.id, * name: "my-new-database", * }); * ``` * * ## Import * * RDB Database can be imported using the `{region}/{id}/{DBNAME}`, e.g. * * bash * * ```sh * $ pulumi import scaleway:index/database:Database rdb01_mydb fr-par/11111111-1111-1111-1111-111111111111/mydb * ``` * * @deprecated scaleway.index/database.Database has been deprecated in favor of scaleway.databases/database.Database */ export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: DatabaseState, opts?: pulumi.CustomResourceOptions): 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: any): obj is Database; /** * UUID of the Database Instance. * * > **Important:** Updates to `instanceId` will recreate the database. */ readonly instanceId: pulumi.Output<string>; /** * Whether the database is managed or not. */ readonly managed: pulumi.Output<boolean>; /** * Name of the database (e.g. `my-new-database`). */ readonly name: pulumi.Output<string>; /** * The name of the owner of the database. */ readonly owner: pulumi.Output<string>; /** * `region`) The region in which the resource exists. */ readonly region: pulumi.Output<string>; /** * Size of the database (in bytes). */ readonly size: pulumi.Output<string>; /** * Create a Database resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ /** @deprecated scaleway.index/database.Database has been deprecated in favor of scaleway.databases/database.Database */ constructor(name: string, args: DatabaseArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Database resources. */ export interface DatabaseState { /** * UUID of the Database Instance. * * > **Important:** Updates to `instanceId` will recreate the database. */ instanceId?: pulumi.Input<string>; /** * Whether the database is managed or not. */ managed?: pulumi.Input<boolean>; /** * Name of the database (e.g. `my-new-database`). */ name?: pulumi.Input<string>; /** * The name of the owner of the database. */ owner?: pulumi.Input<string>; /** * `region`) The region in which the resource exists. */ region?: pulumi.Input<string>; /** * Size of the database (in bytes). */ size?: pulumi.Input<string>; } /** * The set of arguments for constructing a Database resource. */ export interface DatabaseArgs { /** * UUID of the Database Instance. * * > **Important:** Updates to `instanceId` will recreate the database. */ instanceId: pulumi.Input<string>; /** * Name of the database (e.g. `my-new-database`). */ name?: pulumi.Input<string>; /** * `region`) The region in which the resource exists. */ region?: pulumi.Input<string>; }