@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
154 lines (153 loc) • 5.05 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 vedb mysql backup
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-test-subnet",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[2]?.id),
* vpcId: fooVpc.id,
* });
* const fooInstance = new volcengine.vedb_mysql.Instance("fooInstance", {
* chargeType: "PostPaid",
* storageChargeType: "PostPaid",
* dbEngineVersion: "MySQL_8_0",
* dbMinorVersion: "3.0",
* nodeNumber: 2,
* nodeSpec: "vedb.mysql.x4.large",
* subnetId: fooSubnet.id,
* instanceName: "tf-test",
* projectName: "testA",
* tags: [
* {
* key: "tftest",
* value: "tftest",
* },
* {
* key: "tftest2",
* value: "tftest2",
* },
* ],
* });
* const fooBackup = new volcengine.vedb_mysql.Backup("fooBackup", {
* instanceId: fooInstance.id,
* backupPolicy: {
* backupTime: "18:00Z-20:00Z",
* fullBackupPeriod: "Monday,Tuesday,Wednesday",
* backupRetentionPeriod: 8,
* },
* });
* ```
*
* ## Import
*
* VedbMysqlBackup can be imported using the instance id and backup id, e.g.
*
* ```sh
* $ pulumi import volcengine:vedb_mysql/backup:Backup default instanceID:backupId
* ```
*/
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;
/**
* The id of the backup.
*/
readonly backupId: pulumi.Output<string>;
/**
* Backup method. Currently, only physical backup is supported. The value is Physical.
*/
readonly backupMethod: pulumi.Output<string>;
/**
* Data backup strategy for instances.
*/
readonly backupPolicy: pulumi.Output<outputs.vedb_mysql.BackupBackupPolicy>;
/**
* Backup type. Currently, only full backup is supported. The value is Full.
*/
readonly backupType: pulumi.Output<string>;
/**
* The id of the instance.
*/
readonly instanceId: 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 {
/**
* The id of the backup.
*/
backupId?: pulumi.Input<string>;
/**
* Backup method. Currently, only physical backup is supported. The value is Physical.
*/
backupMethod?: pulumi.Input<string>;
/**
* Data backup strategy for instances.
*/
backupPolicy?: pulumi.Input<inputs.vedb_mysql.BackupBackupPolicy>;
/**
* Backup type. Currently, only full backup is supported. The value is Full.
*/
backupType?: pulumi.Input<string>;
/**
* The id of the instance.
*/
instanceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Backup resource.
*/
export interface BackupArgs {
/**
* Backup method. Currently, only physical backup is supported. The value is Physical.
*/
backupMethod?: pulumi.Input<string>;
/**
* Data backup strategy for instances.
*/
backupPolicy?: pulumi.Input<inputs.vedb_mysql.BackupBackupPolicy>;
/**
* Backup type. Currently, only full backup is supported. The value is Full.
*/
backupType?: pulumi.Input<string>;
/**
* The id of the instance.
*/
instanceId: pulumi.Input<string>;
}