1. Packages
  2. Volcengine
  3. API Docs
  4. redis
  5. Backup
Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine

volcengine.redis.Backup

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine

    Provides a resource to manage redis backup

    Example Usage

    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 pulumi
    import pulumi_volcengine as volcengine
    
    foo_zones = volcengine.ecs.get_zones()
    foo_vpc = volcengine.vpc.Vpc("fooVpc",
        vpc_name="acc-test-vpc",
        cidr_block="172.16.0.0/16")
    foo_subnet = volcengine.vpc.Subnet("fooSubnet",
        subnet_name="acc-test-subnet",
        cidr_block="172.16.0.0/24",
        zone_id=foo_zones.zones[0].id,
        vpc_id=foo_vpc.id)
    foo_instance = volcengine.redis.Instance("fooInstance",
        zone_ids=[foo_zones.zones[0].id],
        instance_name="acc-test-tf-redis",
        sharded_cluster=1,
        password="1qaz!QAZ12",
        node_number=2,
        shard_capacity=1024,
        shard_number=2,
        engine_version="5.0",
        subnet_id=foo_subnet.id,
        deletion_protection="disabled",
        vpc_auth_mode="close",
        charge_type="PostPaid",
        port=6381,
        project_name="default")
    foo_backup = volcengine.redis.Backup("fooBackup",
        instance_id=foo_instance.id,
        backup_point_name="acc-test-tf-redis-backup")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/redis"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		fooZones, err := ecs.GetZones(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
    			VpcName:   pulumi.String("acc-test-vpc"),
    			CidrBlock: pulumi.String("172.16.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
    			SubnetName: pulumi.String("acc-test-subnet"),
    			CidrBlock:  pulumi.String("172.16.0.0/24"),
    			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
    			VpcId:      fooVpc.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		fooInstance, err := redis.NewInstance(ctx, "fooInstance", &redis.InstanceArgs{
    			ZoneIds: pulumi.StringArray{
    				pulumi.String(fooZones.Zones[0].Id),
    			},
    			InstanceName:       pulumi.String("acc-test-tf-redis"),
    			ShardedCluster:     pulumi.Int(1),
    			Password:           pulumi.String("1qaz!QAZ12"),
    			NodeNumber:         pulumi.Int(2),
    			ShardCapacity:      pulumi.Int(1024),
    			ShardNumber:        pulumi.Int(2),
    			EngineVersion:      pulumi.String("5.0"),
    			SubnetId:           fooSubnet.ID(),
    			DeletionProtection: pulumi.String("disabled"),
    			VpcAuthMode:        pulumi.String("close"),
    			ChargeType:         pulumi.String("PostPaid"),
    			Port:               pulumi.Int(6381),
    			ProjectName:        pulumi.String("default"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = redis.NewBackup(ctx, "fooBackup", &redis.BackupArgs{
    			InstanceId:      fooInstance.ID(),
    			BackupPointName: pulumi.String("acc-test-tf-redis-backup"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var fooZones = Volcengine.Ecs.GetZones.Invoke();
    
        var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
        {
            VpcName = "acc-test-vpc",
            CidrBlock = "172.16.0.0/16",
        });
    
        var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
        {
            SubnetName = "acc-test-subnet",
            CidrBlock = "172.16.0.0/24",
            ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            VpcId = fooVpc.Id,
        });
    
        var fooInstance = new Volcengine.Redis.Instance("fooInstance", new()
        {
            ZoneIds = new[]
            {
                fooZones.Apply(getZonesResult => getZonesResult.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",
        });
    
        var fooBackup = new Volcengine.Redis.Backup("fooBackup", new()
        {
            InstanceId = fooInstance.Id,
            BackupPointName = "acc-test-tf-redis-backup",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.ecs.EcsFunctions;
    import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
    import com.pulumi.volcengine.vpc.Vpc;
    import com.pulumi.volcengine.vpc.VpcArgs;
    import com.pulumi.volcengine.vpc.Subnet;
    import com.pulumi.volcengine.vpc.SubnetArgs;
    import com.pulumi.volcengine.redis.Instance;
    import com.pulumi.volcengine.redis.InstanceArgs;
    import com.pulumi.volcengine.redis.Backup;
    import com.pulumi.volcengine.redis.BackupArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var fooZones = EcsFunctions.getZones();
    
            var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
                .vpcName("acc-test-vpc")
                .cidrBlock("172.16.0.0/16")
                .build());
    
            var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
                .subnetName("acc-test-subnet")
                .cidrBlock("172.16.0.0/24")
                .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .vpcId(fooVpc.id())
                .build());
    
            var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
                .zoneIds(fooZones.applyValue(getZonesResult -> getZonesResult.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")
                .build());
    
            var fooBackup = new Backup("fooBackup", BackupArgs.builder()        
                .instanceId(fooInstance.id())
                .backupPointName("acc-test-tf-redis-backup")
                .build());
    
        }
    }
    
    resources:
      fooVpc:
        type: volcengine:vpc:Vpc
        properties:
          vpcName: acc-test-vpc
          cidrBlock: 172.16.0.0/16
      fooSubnet:
        type: volcengine:vpc:Subnet
        properties:
          subnetName: acc-test-subnet
          cidrBlock: 172.16.0.0/24
          zoneId: ${fooZones.zones[0].id}
          vpcId: ${fooVpc.id}
      fooInstance:
        type: volcengine:redis:Instance
        properties:
          zoneIds:
            - ${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
      fooBackup:
        type: volcengine:redis:Backup
        properties:
          instanceId: ${fooInstance.id}
          backupPointName: acc-test-tf-redis-backup
    variables:
      fooZones:
        fn::invoke:
          Function: volcengine:ecs:getZones
          Arguments: {}
    

    Create Backup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
    @overload
    def Backup(resource_name: str,
               args: BackupArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Backup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               instance_id: Optional[str] = None,
               backup_point_name: Optional[str] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
    public Backup(String name, BackupArgs args, CustomResourceOptions options)
    
    type: volcengine:redis:Backup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var examplebackupResourceResourceFromRedisbackup = new Volcengine.Redis.Backup("examplebackupResourceResourceFromRedisbackup", new()
    {
        InstanceId = "string",
        BackupPointName = "string",
    });
    
    example, err := redis.NewBackup(ctx, "examplebackupResourceResourceFromRedisbackup", &redis.BackupArgs{
    	InstanceId:      pulumi.String("string"),
    	BackupPointName: pulumi.String("string"),
    })
    
    var examplebackupResourceResourceFromRedisbackup = new com.pulumi.volcengine.redis.Backup("examplebackupResourceResourceFromRedisbackup", com.pulumi.volcengine.redis.BackupArgs.builder()
        .instanceId("string")
        .backupPointName("string")
        .build());
    
    examplebackup_resource_resource_from_redisbackup = volcengine.redis.Backup("examplebackupResourceResourceFromRedisbackup",
        instance_id="string",
        backup_point_name="string")
    
    const examplebackupResourceResourceFromRedisbackup = new volcengine.redis.Backup("examplebackupResourceResourceFromRedisbackup", {
        instanceId: "string",
        backupPointName: "string",
    });
    
    type: volcengine:redis:Backup
    properties:
        backupPointName: string
        instanceId: string
    

    Backup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Backup resource accepts the following input properties:

    InstanceId string
    Id of instance to create backup.
    BackupPointName string
    Set the backup name for the manually created backup.
    InstanceId string
    Id of instance to create backup.
    BackupPointName string
    Set the backup name for the manually created backup.
    instanceId String
    Id of instance to create backup.
    backupPointName String
    Set the backup name for the manually created backup.
    instanceId string
    Id of instance to create backup.
    backupPointName string
    Set the backup name for the manually created backup.
    instance_id str
    Id of instance to create backup.
    backup_point_name str
    Set the backup name for the manually created backup.
    instanceId String
    Id of instance to create backup.
    backupPointName String
    Set the backup name for the manually created backup.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Backup resource produces the following output properties:

    BackupPointDownloadUrls List<BackupBackupPointDownloadUrl>
    The download address information of the backup file to which the current backup point belongs.
    BackupPointId string
    The id of backup point.
    BackupStrategy string
    Backup strategy.
    BackupType string
    Backup type.
    EndTime string
    End time of backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceInfos List<BackupInstanceInfo>
    Information of instance.
    ProjectName string
    Project name of instance.
    Size int
    Size in MiB.
    StartTime string
    Start time of backup.
    Status string
    Status of backup (Creating/Available/Unavailable/Deleting).
    Ttl int
    Backup retention days.
    BackupPointDownloadUrls []BackupBackupPointDownloadUrl
    The download address information of the backup file to which the current backup point belongs.
    BackupPointId string
    The id of backup point.
    BackupStrategy string
    Backup strategy.
    BackupType string
    Backup type.
    EndTime string
    End time of backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceInfos []BackupInstanceInfo
    Information of instance.
    ProjectName string
    Project name of instance.
    Size int
    Size in MiB.
    StartTime string
    Start time of backup.
    Status string
    Status of backup (Creating/Available/Unavailable/Deleting).
    Ttl int
    Backup retention days.
    backupPointDownloadUrls List<BackupBackupPointDownloadUrl>
    The download address information of the backup file to which the current backup point belongs.
    backupPointId String
    The id of backup point.
    backupStrategy String
    Backup strategy.
    backupType String
    Backup type.
    endTime String
    End time of backup.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceInfos List<BackupInstanceInfo>
    Information of instance.
    projectName String
    Project name of instance.
    size Integer
    Size in MiB.
    startTime String
    Start time of backup.
    status String
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl Integer
    Backup retention days.
    backupPointDownloadUrls BackupBackupPointDownloadUrl[]
    The download address information of the backup file to which the current backup point belongs.
    backupPointId string
    The id of backup point.
    backupStrategy string
    Backup strategy.
    backupType string
    Backup type.
    endTime string
    End time of backup.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceInfos BackupInstanceInfo[]
    Information of instance.
    projectName string
    Project name of instance.
    size number
    Size in MiB.
    startTime string
    Start time of backup.
    status string
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl number
    Backup retention days.
    backup_point_download_urls Sequence[BackupBackupPointDownloadUrl]
    The download address information of the backup file to which the current backup point belongs.
    backup_point_id str
    The id of backup point.
    backup_strategy str
    Backup strategy.
    backup_type str
    Backup type.
    end_time str
    End time of backup.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_infos Sequence[BackupInstanceInfo]
    Information of instance.
    project_name str
    Project name of instance.
    size int
    Size in MiB.
    start_time str
    Start time of backup.
    status str
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl int
    Backup retention days.
    backupPointDownloadUrls List<Property Map>
    The download address information of the backup file to which the current backup point belongs.
    backupPointId String
    The id of backup point.
    backupStrategy String
    Backup strategy.
    backupType String
    Backup type.
    endTime String
    End time of backup.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceInfos List<Property Map>
    Information of instance.
    projectName String
    Project name of instance.
    size Number
    Size in MiB.
    startTime String
    Start time of backup.
    status String
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl Number
    Backup retention days.

    Look up Existing Backup Resource

    Get an existing Backup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BackupState, opts?: CustomResourceOptions): Backup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_point_download_urls: Optional[Sequence[BackupBackupPointDownloadUrlArgs]] = None,
            backup_point_id: Optional[str] = None,
            backup_point_name: Optional[str] = None,
            backup_strategy: Optional[str] = None,
            backup_type: Optional[str] = None,
            end_time: Optional[str] = None,
            instance_id: Optional[str] = None,
            instance_infos: Optional[Sequence[BackupInstanceInfoArgs]] = None,
            project_name: Optional[str] = None,
            size: Optional[int] = None,
            start_time: Optional[str] = None,
            status: Optional[str] = None,
            ttl: Optional[int] = None) -> Backup
    func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)
    public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)
    public static Backup get(String name, Output<String> id, BackupState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:redis:Backup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BackupPointDownloadUrls List<BackupBackupPointDownloadUrl>
    The download address information of the backup file to which the current backup point belongs.
    BackupPointId string
    The id of backup point.
    BackupPointName string
    Set the backup name for the manually created backup.
    BackupStrategy string
    Backup strategy.
    BackupType string
    Backup type.
    EndTime string
    End time of backup.
    InstanceId string
    Id of instance to create backup.
    InstanceInfos List<BackupInstanceInfo>
    Information of instance.
    ProjectName string
    Project name of instance.
    Size int
    Size in MiB.
    StartTime string
    Start time of backup.
    Status string
    Status of backup (Creating/Available/Unavailable/Deleting).
    Ttl int
    Backup retention days.
    BackupPointDownloadUrls []BackupBackupPointDownloadUrlArgs
    The download address information of the backup file to which the current backup point belongs.
    BackupPointId string
    The id of backup point.
    BackupPointName string
    Set the backup name for the manually created backup.
    BackupStrategy string
    Backup strategy.
    BackupType string
    Backup type.
    EndTime string
    End time of backup.
    InstanceId string
    Id of instance to create backup.
    InstanceInfos []BackupInstanceInfoArgs
    Information of instance.
    ProjectName string
    Project name of instance.
    Size int
    Size in MiB.
    StartTime string
    Start time of backup.
    Status string
    Status of backup (Creating/Available/Unavailable/Deleting).
    Ttl int
    Backup retention days.
    backupPointDownloadUrls List<BackupBackupPointDownloadUrl>
    The download address information of the backup file to which the current backup point belongs.
    backupPointId String
    The id of backup point.
    backupPointName String
    Set the backup name for the manually created backup.
    backupStrategy String
    Backup strategy.
    backupType String
    Backup type.
    endTime String
    End time of backup.
    instanceId String
    Id of instance to create backup.
    instanceInfos List<BackupInstanceInfo>
    Information of instance.
    projectName String
    Project name of instance.
    size Integer
    Size in MiB.
    startTime String
    Start time of backup.
    status String
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl Integer
    Backup retention days.
    backupPointDownloadUrls BackupBackupPointDownloadUrl[]
    The download address information of the backup file to which the current backup point belongs.
    backupPointId string
    The id of backup point.
    backupPointName string
    Set the backup name for the manually created backup.
    backupStrategy string
    Backup strategy.
    backupType string
    Backup type.
    endTime string
    End time of backup.
    instanceId string
    Id of instance to create backup.
    instanceInfos BackupInstanceInfo[]
    Information of instance.
    projectName string
    Project name of instance.
    size number
    Size in MiB.
    startTime string
    Start time of backup.
    status string
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl number
    Backup retention days.
    backup_point_download_urls Sequence[BackupBackupPointDownloadUrlArgs]
    The download address information of the backup file to which the current backup point belongs.
    backup_point_id str
    The id of backup point.
    backup_point_name str
    Set the backup name for the manually created backup.
    backup_strategy str
    Backup strategy.
    backup_type str
    Backup type.
    end_time str
    End time of backup.
    instance_id str
    Id of instance to create backup.
    instance_infos Sequence[BackupInstanceInfoArgs]
    Information of instance.
    project_name str
    Project name of instance.
    size int
    Size in MiB.
    start_time str
    Start time of backup.
    status str
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl int
    Backup retention days.
    backupPointDownloadUrls List<Property Map>
    The download address information of the backup file to which the current backup point belongs.
    backupPointId String
    The id of backup point.
    backupPointName String
    Set the backup name for the manually created backup.
    backupStrategy String
    Backup strategy.
    backupType String
    Backup type.
    endTime String
    End time of backup.
    instanceId String
    Id of instance to create backup.
    instanceInfos List<Property Map>
    Information of instance.
    projectName String
    Project name of instance.
    size Number
    Size in MiB.
    startTime String
    Start time of backup.
    status String
    Status of backup (Creating/Available/Unavailable/Deleting).
    ttl Number
    Backup retention days.

    Supporting Types

    BackupBackupPointDownloadUrl, BackupBackupPointDownloadUrlArgs

    PrivateDownloadUrl string
    The private network download address for RDB files.
    PublicDownloadUrl string
    The public network download address for RDB files.
    RdbFileSize int
    RDB file size, unit: Byte.
    ShardId string
    The shard ID where the RDB file is located.
    PrivateDownloadUrl string
    The private network download address for RDB files.
    PublicDownloadUrl string
    The public network download address for RDB files.
    RdbFileSize int
    RDB file size, unit: Byte.
    ShardId string
    The shard ID where the RDB file is located.
    privateDownloadUrl String
    The private network download address for RDB files.
    publicDownloadUrl String
    The public network download address for RDB files.
    rdbFileSize Integer
    RDB file size, unit: Byte.
    shardId String
    The shard ID where the RDB file is located.
    privateDownloadUrl string
    The private network download address for RDB files.
    publicDownloadUrl string
    The public network download address for RDB files.
    rdbFileSize number
    RDB file size, unit: Byte.
    shardId string
    The shard ID where the RDB file is located.
    private_download_url str
    The private network download address for RDB files.
    public_download_url str
    The public network download address for RDB files.
    rdb_file_size int
    RDB file size, unit: Byte.
    shard_id str
    The shard ID where the RDB file is located.
    privateDownloadUrl String
    The private network download address for RDB files.
    publicDownloadUrl String
    The public network download address for RDB files.
    rdbFileSize Number
    RDB file size, unit: Byte.
    shardId String
    The shard ID where the RDB file is located.

    BackupInstanceInfo, BackupInstanceInfoArgs

    AccountId int
    Id of account.
    ArchType string
    Arch type of instance(Standard/Cluster).
    ChargeType string
    Charge type of instance(Postpaid/Prepaid).
    DeletionProtection string
    The status of the deletion protection function of the instance.
    EngineVersion string
    Engine version of instance.
    ExpiredTime string
    Expired time of instance.
    InstanceId string
    Id of instance to create backup.
    InstanceName string
    Name of instance.
    MaintenanceTime string
    The maintainable period (in UTC) of the instance.
    NetworkType string
    Network type of instance.
    RegionId string
    Id of region.
    Replicas int
    Count of replica in which shard.
    ShardCapacity int
    Capacity of shard.
    ShardNumber int
    The number of shards in the instance.
    TotalCapacity int
    Total capacity of instance.
    VpcId string
    The private network ID of the instance.
    ZoneIds List<string>
    List of id of zone.
    AccountId int
    Id of account.
    ArchType string
    Arch type of instance(Standard/Cluster).
    ChargeType string
    Charge type of instance(Postpaid/Prepaid).
    DeletionProtection string
    The status of the deletion protection function of the instance.
    EngineVersion string
    Engine version of instance.
    ExpiredTime string
    Expired time of instance.
    InstanceId string
    Id of instance to create backup.
    InstanceName string
    Name of instance.
    MaintenanceTime string
    The maintainable period (in UTC) of the instance.
    NetworkType string
    Network type of instance.
    RegionId string
    Id of region.
    Replicas int
    Count of replica in which shard.
    ShardCapacity int
    Capacity of shard.
    ShardNumber int
    The number of shards in the instance.
    TotalCapacity int
    Total capacity of instance.
    VpcId string
    The private network ID of the instance.
    ZoneIds []string
    List of id of zone.
    accountId Integer
    Id of account.
    archType String
    Arch type of instance(Standard/Cluster).
    chargeType String
    Charge type of instance(Postpaid/Prepaid).
    deletionProtection String
    The status of the deletion protection function of the instance.
    engineVersion String
    Engine version of instance.
    expiredTime String
    Expired time of instance.
    instanceId String
    Id of instance to create backup.
    instanceName String
    Name of instance.
    maintenanceTime String
    The maintainable period (in UTC) of the instance.
    networkType String
    Network type of instance.
    regionId String
    Id of region.
    replicas Integer
    Count of replica in which shard.
    shardCapacity Integer
    Capacity of shard.
    shardNumber Integer
    The number of shards in the instance.
    totalCapacity Integer
    Total capacity of instance.
    vpcId String
    The private network ID of the instance.
    zoneIds List<String>
    List of id of zone.
    accountId number
    Id of account.
    archType string
    Arch type of instance(Standard/Cluster).
    chargeType string
    Charge type of instance(Postpaid/Prepaid).
    deletionProtection string
    The status of the deletion protection function of the instance.
    engineVersion string
    Engine version of instance.
    expiredTime string
    Expired time of instance.
    instanceId string
    Id of instance to create backup.
    instanceName string
    Name of instance.
    maintenanceTime string
    The maintainable period (in UTC) of the instance.
    networkType string
    Network type of instance.
    regionId string
    Id of region.
    replicas number
    Count of replica in which shard.
    shardCapacity number
    Capacity of shard.
    shardNumber number
    The number of shards in the instance.
    totalCapacity number
    Total capacity of instance.
    vpcId string
    The private network ID of the instance.
    zoneIds string[]
    List of id of zone.
    account_id int
    Id of account.
    arch_type str
    Arch type of instance(Standard/Cluster).
    charge_type str
    Charge type of instance(Postpaid/Prepaid).
    deletion_protection str
    The status of the deletion protection function of the instance.
    engine_version str
    Engine version of instance.
    expired_time str
    Expired time of instance.
    instance_id str
    Id of instance to create backup.
    instance_name str
    Name of instance.
    maintenance_time str
    The maintainable period (in UTC) of the instance.
    network_type str
    Network type of instance.
    region_id str
    Id of region.
    replicas int
    Count of replica in which shard.
    shard_capacity int
    Capacity of shard.
    shard_number int
    The number of shards in the instance.
    total_capacity int
    Total capacity of instance.
    vpc_id str
    The private network ID of the instance.
    zone_ids Sequence[str]
    List of id of zone.
    accountId Number
    Id of account.
    archType String
    Arch type of instance(Standard/Cluster).
    chargeType String
    Charge type of instance(Postpaid/Prepaid).
    deletionProtection String
    The status of the deletion protection function of the instance.
    engineVersion String
    Engine version of instance.
    expiredTime String
    Expired time of instance.
    instanceId String
    Id of instance to create backup.
    instanceName String
    Name of instance.
    maintenanceTime String
    The maintainable period (in UTC) of the instance.
    networkType String
    Network type of instance.
    regionId String
    Id of region.
    replicas Number
    Count of replica in which shard.
    shardCapacity Number
    Capacity of shard.
    shardNumber Number
    The number of shards in the instance.
    totalCapacity Number
    Total capacity of instance.
    vpcId String
    The private network ID of the instance.
    zoneIds List<String>
    List of id of zone.

    Import

    Redis Backup can be imported using the instanceId:backupId, e.g.

    $ pulumi import volcengine:redis/backup:Backup default redis-cn02aqusft7ws****:b-cn02xmmrp751i9cdzcphjmk4****
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine