@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
201 lines (200 loc) • 6.15 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 redis 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?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooInstance = new volcengine.redis.Instance("fooInstance", {
* zoneIds: [fooZones.then(fooZones => fooZones.zones?.[0]?.id)],
* instanceName: "acc-test-tf-redis",
* shardedCluster: 1,
* password: "1qaz!QAZ12",
* nodeNumber: 2,
* shardCapacity: 1024,
* shardNumber: 2,
* engineVersion: "5.0",
* subnetId: fooSubnet.id,
* deletionProtection: "disabled",
* vpcAuthMode: "close",
* chargeType: "PostPaid",
* port: 6381,
* projectName: "default",
* });
* const fooBackup = new volcengine.redis.Backup("fooBackup", {
* instanceId: fooInstance.id,
* backupPointName: "acc-test-tf-redis-backup",
* });
* ```
*
* ## Import
*
* Redis Backup can be imported using the instanceId:backupId, e.g.
*
* ```sh
* $ pulumi import volcengine:redis/backup:Backup default redis-cn02aqusft7ws****:b-cn02xmmrp751i9cdzcphjmk4****
* ```
*/
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 download address information of the backup file to which the current backup point belongs.
*/
readonly backupPointDownloadUrls: pulumi.Output<outputs.redis.BackupBackupPointDownloadUrl[]>;
/**
* The id of backup point.
*/
readonly backupPointId: pulumi.Output<string>;
/**
* Set the backup name for the manually created backup.
*/
readonly backupPointName: pulumi.Output<string>;
/**
* Backup strategy.
*/
readonly backupStrategy: pulumi.Output<string>;
/**
* Backup type.
*/
readonly backupType: pulumi.Output<string>;
/**
* End time of backup.
*/
readonly endTime: pulumi.Output<string>;
/**
* Id of instance to create backup.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Information of instance.
*/
readonly instanceInfos: pulumi.Output<outputs.redis.BackupInstanceInfo[]>;
/**
* Project name of instance.
*/
readonly projectName: pulumi.Output<string>;
/**
* Size in MiB.
*/
readonly size: pulumi.Output<number>;
/**
* Start time of backup.
*/
readonly startTime: pulumi.Output<string>;
/**
* Status of backup (Creating/Available/Unavailable/Deleting).
*/
readonly status: pulumi.Output<string>;
/**
* Backup retention days.
*/
readonly ttl: pulumi.Output<number>;
/**
* 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 download address information of the backup file to which the current backup point belongs.
*/
backupPointDownloadUrls?: pulumi.Input<pulumi.Input<inputs.redis.BackupBackupPointDownloadUrl>[]>;
/**
* The id of backup point.
*/
backupPointId?: pulumi.Input<string>;
/**
* Set the backup name for the manually created backup.
*/
backupPointName?: pulumi.Input<string>;
/**
* Backup strategy.
*/
backupStrategy?: pulumi.Input<string>;
/**
* Backup type.
*/
backupType?: pulumi.Input<string>;
/**
* End time of backup.
*/
endTime?: pulumi.Input<string>;
/**
* Id of instance to create backup.
*/
instanceId?: pulumi.Input<string>;
/**
* Information of instance.
*/
instanceInfos?: pulumi.Input<pulumi.Input<inputs.redis.BackupInstanceInfo>[]>;
/**
* Project name of instance.
*/
projectName?: pulumi.Input<string>;
/**
* Size in MiB.
*/
size?: pulumi.Input<number>;
/**
* Start time of backup.
*/
startTime?: pulumi.Input<string>;
/**
* Status of backup (Creating/Available/Unavailable/Deleting).
*/
status?: pulumi.Input<string>;
/**
* Backup retention days.
*/
ttl?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Backup resource.
*/
export interface BackupArgs {
/**
* Set the backup name for the manually created backup.
*/
backupPointName?: pulumi.Input<string>;
/**
* Id of instance to create backup.
*/
instanceId: pulumi.Input<string>;
}