@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
198 lines (197 loc) • 6.24 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages database backups.
* 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: "database",
* });
* const mainDatabaseBackup = new scaleway.databases.DatabaseBackup("main", {
* instanceId: main.id,
* databaseName: mainDatabase.name,
* });
* ```
*
* ### With expiration
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.databases.DatabaseBackup("main", {
* instanceId: mainScalewayRdbInstance.id,
* databaseName: mainScalewayRdbDatabase.name,
* expiresAt: "2022-06-16T07:48:44Z",
* });
* ```
*
* ## Import
*
* Databases can be imported using the `{region}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/databaseBackup:DatabaseBackup mybackup fr-par/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/databasebackup.DatabaseBackup has been deprecated in favor of scaleway.databases/databasebackup.DatabaseBackup
*/
export declare class DatabaseBackup extends pulumi.CustomResource {
/**
* Get an existing DatabaseBackup 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?: DatabaseBackupState, opts?: pulumi.CustomResourceOptions): DatabaseBackup;
/**
* Returns true if the given object is an instance of DatabaseBackup. 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 DatabaseBackup;
/**
* Creation date (Format ISO 8601).
*/
readonly createdAt: pulumi.Output<string>;
/**
* Name of the database of this backup.
*/
readonly databaseName: pulumi.Output<string>;
/**
* Expiration date (Format ISO 8601).
*
* > **Important:** `expiresAt` cannot be removed after being set.
*/
readonly expiresAt: pulumi.Output<string | undefined>;
/**
* UUID of the Database Instance.
*
* > **Important:** Updates to `instanceId` will recreate the backup.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Name of the instance of the backup.
*/
readonly instanceName: pulumi.Output<string>;
/**
* Name of the database (e.g. `my-database`).
*/
readonly name: pulumi.Output<string>;
/**
* `region`) The region in which the resource exists.
*/
readonly region: pulumi.Output<string>;
/**
* Size of the backup (in bytes).
*/
readonly size: pulumi.Output<number>;
/**
* Updated date (Format ISO 8601).
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a DatabaseBackup 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/databasebackup.DatabaseBackup has been deprecated in favor of scaleway.databases/databasebackup.DatabaseBackup */
constructor(name: string, args: DatabaseBackupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DatabaseBackup resources.
*/
export interface DatabaseBackupState {
/**
* Creation date (Format ISO 8601).
*/
createdAt?: pulumi.Input<string>;
/**
* Name of the database of this backup.
*/
databaseName?: pulumi.Input<string>;
/**
* Expiration date (Format ISO 8601).
*
* > **Important:** `expiresAt` cannot be removed after being set.
*/
expiresAt?: pulumi.Input<string>;
/**
* UUID of the Database Instance.
*
* > **Important:** Updates to `instanceId` will recreate the backup.
*/
instanceId?: pulumi.Input<string>;
/**
* Name of the instance of the backup.
*/
instanceName?: pulumi.Input<string>;
/**
* Name of the database (e.g. `my-database`).
*/
name?: pulumi.Input<string>;
/**
* `region`) The region in which the resource exists.
*/
region?: pulumi.Input<string>;
/**
* Size of the backup (in bytes).
*/
size?: pulumi.Input<number>;
/**
* Updated date (Format ISO 8601).
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DatabaseBackup resource.
*/
export interface DatabaseBackupArgs {
/**
* Name of the database of this backup.
*/
databaseName: pulumi.Input<string>;
/**
* Expiration date (Format ISO 8601).
*
* > **Important:** `expiresAt` cannot be removed after being set.
*/
expiresAt?: pulumi.Input<string>;
/**
* UUID of the Database Instance.
*
* > **Important:** Updates to `instanceId` will recreate the backup.
*/
instanceId: pulumi.Input<string>;
/**
* Name of the database (e.g. `my-database`).
*/
name?: pulumi.Input<string>;
/**
* `region`) The region in which the resource exists.
*/
region?: pulumi.Input<string>;
}