@lbrlabs/pulumi-scaleway/databaseInstance.d.ts

A Pulumi package for creating and managing scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * ## Import
 *
 * Database Instance can be imported using the `{region}/{id}`, e.g. bash
 *
 * ```sh
 *  $ pulumi import scaleway:index/databaseInstance:DatabaseInstance rdb01 fr-par/11111111-1111-1111-1111-111111111111
 * ```
 */
export declare class DatabaseInstance extends pulumi.CustomResource {
    /**
     * Get an existing DatabaseInstance 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?: DatabaseInstanceState, opts?: pulumi.CustomResourceOptions): DatabaseInstance;
    /**
     * Returns true if the given object is an instance of DatabaseInstance.  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 DatabaseInstance;
    /**
     * Boolean to store logical backups in the same region as the database instance.
     */
    readonly backupSameRegion: pulumi.Output<boolean>;
    /**
     * Backup schedule frequency in hours.
     */
    readonly backupScheduleFrequency: pulumi.Output<number>;
    /**
     * Backup schedule retention in days.
     */
    readonly backupScheduleRetention: pulumi.Output<number>;
    /**
     * Certificate of the database instance.
     */
    readonly certificate: pulumi.Output<string>;
    /**
     * Disable automated backup for the database instance.
     */
    readonly disableBackup: pulumi.Output<boolean | undefined>;
    /**
     * (Deprecated) The IP of the Database Instance.
     *
     * @deprecated Please use the private_network or the load_balancer attribute
     */
    readonly endpointIp: pulumi.Output<string>;
    /**
     * (Deprecated) The port of the Database Instance.
     */
    readonly endpointPort: pulumi.Output<number>;
    /**
     * Database Instance's engine version (e.g. `PostgreSQL-11`).
     *
     * > **Important:** Updates to `engine` will recreate the Database Instance.
     */
    readonly engine: pulumi.Output<string>;
    /**
     * Map of engine settings to be set at database initialisation.
     *
     * > **Important:** Updates to `initSettings` will recreate the Database Instance.
     */
    readonly initSettings: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Enable or disable high availability for the database instance.
     *
     * > **Important:** Updates to `isHaCluster` will recreate the Database Instance.
     */
    readonly isHaCluster: pulumi.Output<boolean | undefined>;
    /**
     * List of load balancer endpoints of the database instance.
     */
    readonly loadBalancers: pulumi.Output<outputs.DatabaseInstanceLoadBalancer[]>;
    /**
     * The name of the Database Instance.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The type of database instance you want to create (e.g. `db-dev-s`).
     *
     * > **Important:** Updates to `nodeType` will upgrade the Database Instance to the desired `nodeType` without any
     * interruption. Keep in mind that you cannot downgrade a Database Instance.
     */
    readonly nodeType: pulumi.Output<string>;
    /**
     * The organization ID the Database Instance is associated with.
     */
    readonly organizationId: pulumi.Output<string>;
    /**
     * Password for the first user of the database instance.
     */
    readonly password: pulumi.Output<string | undefined>;
    /**
     * List of private networks endpoints of the database instance.
     */
    readonly privateNetwork: pulumi.Output<outputs.DatabaseInstancePrivateNetwork | undefined>;
    /**
     * `projectId`) The ID of the project the Database
     * Instance is associated with.
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * List of read replicas of the database instance.
     */
    readonly readReplicas: pulumi.Output<outputs.DatabaseInstanceReadReplica[]>;
    /**
     * `region`) The region
     * in which the Database Instance should be created.
     */
    readonly region: pulumi.Output<string>;
    /**
     * Map of engine settings to be set. Using this option will override default config.
     */
    readonly settings: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The tags associated with the Database Instance.
     */
    readonly tags: pulumi.Output<string[] | undefined>;
    /**
     * Identifier for the first user of the database instance.
     *
     * > **Important:** Updates to `userName` will recreate the Database Instance.
     */
    readonly userName: pulumi.Output<string | undefined>;
    /**
     * Volume size (in GB) when `volumeType` is set to `bssd`.
     */
    readonly volumeSizeInGb: pulumi.Output<number>;
    /**
     * Type of volume where data are stored (`bssd` or `lssd`).
     */
    readonly volumeType: pulumi.Output<string | undefined>;
    /**
     * Create a DatabaseInstance 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: DatabaseInstanceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DatabaseInstance resources.
 */
export interface DatabaseInstanceState {
    /**
     * Boolean to store logical backups in the same region as the database instance.
     */
    backupSameRegion?: pulumi.Input<boolean>;
    /**
     * Backup schedule frequency in hours.
     */
    backupScheduleFrequency?: pulumi.Input<number>;
    /**
     * Backup schedule retention in days.
     */
    backupScheduleRetention?: pulumi.Input<number>;
    /**
     * Certificate of the database instance.
     */
    certificate?: pulumi.Input<string>;
    /**
     * Disable automated backup for the database instance.
     */
    disableBackup?: pulumi.Input<boolean>;
    /**
     * (Deprecated) The IP of the Database Instance.
     *
     * @deprecated Please use the private_network or the load_balancer attribute
     */
    endpointIp?: pulumi.Input<string>;
    /**
     * (Deprecated) The port of the Database Instance.
     */
    endpointPort?: pulumi.Input<number>;
    /**
     * Database Instance's engine version (e.g. `PostgreSQL-11`).
     *
     * > **Important:** Updates to `engine` will recreate the Database Instance.
     */
    engine?: pulumi.Input<string>;
    /**
     * Map of engine settings to be set at database initialisation.
     *
     * > **Important:** Updates to `initSettings` will recreate the Database Instance.
     */
    initSettings?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Enable or disable high availability for the database instance.
     *
     * > **Important:** Updates to `isHaCluster` will recreate the Database Instance.
     */
    isHaCluster?: pulumi.Input<boolean>;
    /**
     * List of load balancer endpoints of the database instance.
     */
    loadBalancers?: pulumi.Input<pulumi.Input<inputs.DatabaseInstanceLoadBalancer>[]>;
    /**
     * The name of the Database Instance.
     */
    name?: pulumi.Input<string>;
    /**
     * The type of database instance you want to create (e.g. `db-dev-s`).
     *
     * > **Important:** Updates to `nodeType` will upgrade the Database Instance to the desired `nodeType` without any
     * interruption. Keep in mind that you cannot downgrade a Database Instance.
     */
    nodeType?: pulumi.Input<string>;
    /**
     * The organization ID the Database Instance is associated with.
     */
    organizationId?: pulumi.Input<string>;
    /**
     * Password for the first user of the database instance.
     */
    password?: pulumi.Input<string>;
    /**
     * List of private networks endpoints of the database instance.
     */
    privateNetwork?: pulumi.Input<inputs.DatabaseInstancePrivateNetwork>;
    /**
     * `projectId`) The ID of the project the Database
     * Instance is associated with.
     */
    projectId?: pulumi.Input<string>;
    /**
     * List of read replicas of the database instance.
     */
    readReplicas?: pulumi.Input<pulumi.Input<inputs.DatabaseInstanceReadReplica>[]>;
    /**
     * `region`) The region
     * in which the Database Instance should be created.
     */
    region?: pulumi.Input<string>;
    /**
     * Map of engine settings to be set. Using this option will override default config.
     */
    settings?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The tags associated with the Database Instance.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Identifier for the first user of the database instance.
     *
     * > **Important:** Updates to `userName` will recreate the Database Instance.
     */
    userName?: pulumi.Input<string>;
    /**
     * Volume size (in GB) when `volumeType` is set to `bssd`.
     */
    volumeSizeInGb?: pulumi.Input<number>;
    /**
     * Type of volume where data are stored (`bssd` or `lssd`).
     */
    volumeType?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a DatabaseInstance resource.
 */
export interface DatabaseInstanceArgs {
    /**
     * Boolean to store logical backups in the same region as the database instance.
     */
    backupSameRegion?: pulumi.Input<boolean>;
    /**
     * Backup schedule frequency in hours.
     */
    backupScheduleFrequency?: pulumi.Input<number>;
    /**
     * Backup schedule retention in days.
     */
    backupScheduleRetention?: pulumi.Input<number>;
    /**
     * Disable automated backup for the database instance.
     */
    disableBackup?: pulumi.Input<boolean>;
    /**
     * Database Instance's engine version (e.g. `PostgreSQL-11`).
     *
     * > **Important:** Updates to `engine` will recreate the Database Instance.
     */
    engine: pulumi.Input<string>;
    /**
     * Map of engine settings to be set at database initialisation.
     *
     * > **Important:** Updates to `initSettings` will recreate the Database Instance.
     */
    initSettings?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Enable or disable high availability for the database instance.
     *
     * > **Important:** Updates to `isHaCluster` will recreate the Database Instance.
     */
    isHaCluster?: pulumi.Input<boolean>;
    /**
     * The name of the Database Instance.
     */
    name?: pulumi.Input<string>;
    /**
     * The type of database instance you want to create (e.g. `db-dev-s`).
     *
     * > **Important:** Updates to `nodeType` will upgrade the Database Instance to the desired `nodeType` without any
     * interruption. Keep in mind that you cannot downgrade a Database Instance.
     */
    nodeType: pulumi.Input<string>;
    /**
     * Password for the first user of the database instance.
     */
    password?: pulumi.Input<string>;
    /**
     * List of private networks endpoints of the database instance.
     */
    privateNetwork?: pulumi.Input<inputs.DatabaseInstancePrivateNetwork>;
    /**
     * `projectId`) The ID of the project the Database
     * Instance is associated with.
     */
    projectId?: pulumi.Input<string>;
    /**
     * `region`) The region
     * in which the Database Instance should be created.
     */
    region?: pulumi.Input<string>;
    /**
     * Map of engine settings to be set. Using this option will override default config.
     */
    settings?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The tags associated with the Database Instance.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Identifier for the first user of the database instance.
     *
     * > **Important:** Updates to `userName` will recreate the Database Instance.
     */
    userName?: pulumi.Input<string>;
    /**
     * Volume size (in GB) when `volumeType` is set to `bssd`.
     */
    volumeSizeInGb?: pulumi.Input<number>;
    /**
     * Type of volume where data are stored (`bssd` or `lssd`).
     */
    volumeType?: pulumi.Input<string>;
}