@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
183 lines (182 loc) • 6.36 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "../types";
/**
* Manages a RDS manual backup resource within HuaweiCloud.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const instanceId = config.requireObject("instanceId");
* const backupName = config.requireObject("backupName");
* const test = new huaweicloud.rds.Backup("test", {instanceId: instanceId});
* ```
*
* ## Import
*
* The rds manual backup can be imported using the instance ID and the backup ID separated by a slash, e.g.bash
*
* ```sh
* $ pulumi import huaweicloud:Rds/backup:Backup test 1ce123456a00f2591fabc00385ff1235/0ce123456a00f2591fabc00385ff1234
* ```
*/
export declare class Backup extends pulumi.CustomResource {
/**
* Get an existing Backup 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?: BackupState, opts?: pulumi.CustomResourceOptions): Backup;
/**
* Returns true if the given object is an instance of Backup. 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 Backup;
/**
* Whether a DDM instance has been associated.
*/
readonly associatedWithDdm: pulumi.Output<boolean>;
/**
* Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
*/
readonly beginTime: pulumi.Output<string>;
/**
* List of self-built Microsoft SQL Server databases that are partially
* backed up.
* (Only Microsoft SQL Server supports partial backups.).
*/
readonly databases: pulumi.Output<outputs.Rds.BackupDatabase[]>;
/**
* The description about the backup.
* It contains a maximum of `256` characters and cannot contain the following special characters: `>!<"&'=`.
*/
readonly description: pulumi.Output<string>;
/**
* Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.
*/
readonly endTime: pulumi.Output<string>;
/**
* Instance ID.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Database to be backed up for Microsoft SQL Server.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
*/
readonly region: pulumi.Output<string>;
/**
* Backup size in KB.
*/
readonly size: pulumi.Output<number>;
/**
* Backup status.
* The options are as follows:
* + **BUILDING**: Backup in progress.
* + **COMPLETED**: Backup completed.
* + **FAILED**: Backup failed.
* + **DELETING**: Backup being deleted.
*/
readonly status: pulumi.Output<string>;
/**
* Create a Backup 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: BackupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Backup resources.
*/
export interface BackupState {
/**
* Whether a DDM instance has been associated.
*/
associatedWithDdm?: pulumi.Input<boolean>;
/**
* Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
*/
beginTime?: pulumi.Input<string>;
/**
* List of self-built Microsoft SQL Server databases that are partially
* backed up.
* (Only Microsoft SQL Server supports partial backups.).
*/
databases?: pulumi.Input<pulumi.Input<inputs.Rds.BackupDatabase>[]>;
/**
* The description about the backup.
* It contains a maximum of `256` characters and cannot contain the following special characters: `>!<"&'=`.
*/
description?: pulumi.Input<string>;
/**
* Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.
*/
endTime?: pulumi.Input<string>;
/**
* Instance ID.
*/
instanceId?: pulumi.Input<string>;
/**
* Database to be backed up for Microsoft SQL Server.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Backup size in KB.
*/
size?: pulumi.Input<number>;
/**
* Backup status.
* The options are as follows:
* + **BUILDING**: Backup in progress.
* + **COMPLETED**: Backup completed.
* + **FAILED**: Backup failed.
* + **DELETING**: Backup being deleted.
*/
status?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Backup resource.
*/
export interface BackupArgs {
/**
* List of self-built Microsoft SQL Server databases that are partially
* backed up.
* (Only Microsoft SQL Server supports partial backups.).
*/
databases?: pulumi.Input<pulumi.Input<inputs.Rds.BackupDatabase>[]>;
/**
* The description about the backup.
* It contains a maximum of `256` characters and cannot contain the following special characters: `>!<"&'=`.
*/
description?: pulumi.Input<string>;
/**
* Instance ID.
*/
instanceId: pulumi.Input<string>;
/**
* Database to be backed up for Microsoft SQL Server.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
*/
region?: pulumi.Input<string>;
}