@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
127 lines (126 loc) • 4.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage rds postgresql restore backup
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const example = new volcengine.rds_postgresql.RestoreBackup("example", {
* backupId: "20251214-200431-0698LD",
* databases: [{
* dbName: "test",
* newDbName: "test_restored",
* }],
* sourceDbInstanceId: "postgres-72715e0d9f58",
* targetDbInstanceAccount: "super",
* targetDbInstanceId: "postgres-72715e0d9f58",
* });
* ```
*
* ## Import
*
* RdsPostgresqlRestoreBackup can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:rds_postgresql/restoreBackup:RestoreBackup default resource_id
* ```
*/
export declare class RestoreBackup extends pulumi.CustomResource {
/**
* Get an existing RestoreBackup 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?: RestoreBackupState, opts?: pulumi.CustomResourceOptions): RestoreBackup;
/**
* Returns true if the given object is an instance of RestoreBackup. 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 RestoreBackup;
/**
* The backup ID used for restore.Only supports restoring data to an existing instance through logical backup.
*/
readonly backupId: pulumi.Output<string>;
/**
* Information of the database to be restored.
*/
readonly databases: pulumi.Output<outputs.rds_postgresql.RestoreBackupDatabase[]>;
/**
* The ID of the instance to which the backup belongs.
*/
readonly sourceDbInstanceId: pulumi.Output<string>;
/**
* The account used as the Owner of the newly restored database in the target instance.
*/
readonly targetDbInstanceAccount: pulumi.Output<string>;
/**
* The ID of the target instance for restore.
*/
readonly targetDbInstanceId: pulumi.Output<string>;
/**
* Create a RestoreBackup 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: RestoreBackupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RestoreBackup resources.
*/
export interface RestoreBackupState {
/**
* The backup ID used for restore.Only supports restoring data to an existing instance through logical backup.
*/
backupId?: pulumi.Input<string>;
/**
* Information of the database to be restored.
*/
databases?: pulumi.Input<pulumi.Input<inputs.rds_postgresql.RestoreBackupDatabase>[]>;
/**
* The ID of the instance to which the backup belongs.
*/
sourceDbInstanceId?: pulumi.Input<string>;
/**
* The account used as the Owner of the newly restored database in the target instance.
*/
targetDbInstanceAccount?: pulumi.Input<string>;
/**
* The ID of the target instance for restore.
*/
targetDbInstanceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RestoreBackup resource.
*/
export interface RestoreBackupArgs {
/**
* The backup ID used for restore.Only supports restoring data to an existing instance through logical backup.
*/
backupId: pulumi.Input<string>;
/**
* Information of the database to be restored.
*/
databases: pulumi.Input<pulumi.Input<inputs.rds_postgresql.RestoreBackupDatabase>[]>;
/**
* The ID of the instance to which the backup belongs.
*/
sourceDbInstanceId: pulumi.Input<string>;
/**
* The account used as the Owner of the newly restored database in the target instance.
*/
targetDbInstanceAccount: pulumi.Input<string>;
/**
* The ID of the target instance for restore.
*/
targetDbInstanceId: pulumi.Input<string>;
}