@pulumiverse/scaleway/databases/serverlessDatabase.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * 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
 * ```
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: ServerlessDatabaseState, opts?: pulumi.CustomResourceOptions): 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: any): obj is ServerlessDatabase;
    /**
     * The endpoint of the database.
     */
    readonly endpoint: pulumi.Output<string>;
    /**
     * The maximum number of CPU units for your database. Defaults to 15.
     */
    readonly maxCpu: pulumi.Output<number | undefined>;
    /**
     * The minimum number of CPU units for your database. Defaults to 0.
     */
    readonly minCpu: pulumi.Output<number | undefined>;
    /**
     * The name of the database (e.g. `my-new-database`).
     *
     * > **Important:** Updates to the `name` argument will recreate the database.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The projectId 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 | undefined>;
    /**
     * Create a ServerlessDatabase 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?: ServerlessDatabaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ServerlessDatabase resources.
 */
export interface ServerlessDatabaseState {
    /**
     * The endpoint of the database.
     */
    endpoint?: pulumi.Input<string | undefined>;
    /**
     * The maximum number of CPU units for your database. Defaults to 15.
     */
    maxCpu?: pulumi.Input<number | undefined>;
    /**
     * The minimum number of CPU units for your database. Defaults to 0.
     */
    minCpu?: pulumi.Input<number | undefined>;
    /**
     * The name of the database (e.g. `my-new-database`).
     *
     * > **Important:** Updates to the `name` argument will recreate the database.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The projectId you want to attach the resource to
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * `region`) The region in which the resource exists.
     */
    region?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a ServerlessDatabase resource.
 */
export interface ServerlessDatabaseArgs {
    /**
     * The maximum number of CPU units for your database. Defaults to 15.
     */
    maxCpu?: pulumi.Input<number | undefined>;
    /**
     * The minimum number of CPU units for your database. Defaults to 0.
     */
    minCpu?: pulumi.Input<number | undefined>;
    /**
     * The name of the database (e.g. `my-new-database`).
     *
     * > **Important:** Updates to the `name` argument will recreate the database.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The projectId you want to attach the resource to
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * `region`) The region in which the resource exists.
     */
    region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=serverlessDatabase.d.ts.map