UNPKG

@lbrlabs/pulumi-scaleway

Version:

A Pulumi package for creating and managing scaleway cloud resources.

138 lines (137 loc) 4.51 kB
import * as pulumi from "@pulumi/pulumi"; /** * Creates and manages Scaleway DocumentDB database. * For more information, see [the documentation](https://developers.scaleway.com/en/products/rdb/api). * * ## Examples * * ### Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@lbrlabs/pulumi-scaleway"; * * const main = new scaleway.DocumentdbDatabase("main", {instanceId: "11111111-1111-1111-1111-111111111111"}); * ``` * * ## Import * * DocumentDB Database can be imported using the `{region}/{id}/{DBNAME}`, e.g. bash * * ```sh * $ pulumi import scaleway:index/documentdbDatabase:DocumentdbDatabase mydb fr-par/11111111-1111-1111-1111-111111111111/mydb * ``` */ export declare class DocumentdbDatabase extends pulumi.CustomResource { /** * Get an existing DocumentdbDatabase 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?: DocumentdbDatabaseState, opts?: pulumi.CustomResourceOptions): DocumentdbDatabase; /** * Returns true if the given object is an instance of DocumentdbDatabase. 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 DocumentdbDatabase; /** * UUID of the documentdb 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>; /** * The project_id you want to attach the resource to */ readonly projectId: pulumi.Output<string>; /** * `region`) The region in which the resource exists. */ readonly region: pulumi.Output<string>; /** * Size in gigabytes of the database. */ readonly size: pulumi.Output<string>; /** * Create a DocumentdbDatabase 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. */ constructor(name: string, args: DocumentdbDatabaseArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DocumentdbDatabase resources. */ export interface DocumentdbDatabaseState { /** * UUID of the documentdb 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>; /** * The project_id you want to attach the resource to */ projectId?: pulumi.Input<string>; /** * `region`) The region in which the resource exists. */ region?: pulumi.Input<string>; /** * Size in gigabytes of the database. */ size?: pulumi.Input<string>; } /** * The set of arguments for constructing a DocumentdbDatabase resource. */ export interface DocumentdbDatabaseArgs { /** * UUID of the documentdb 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>; /** * The project_id you want to attach the resource to */ projectId?: pulumi.Input<string>; /** * `region`) The region in which the resource exists. */ region?: pulumi.Input<string>; }