1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. vedbm
  5. Backup
Viewing docs for volcenginecc v0.0.28
published on Thursday, Mar 26, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.28
published on Thursday, Mar 26, 2026 by Volcengine

    云数据库 veDB备份管理

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const vedbmbackupDemo = new volcenginecc.vedbm.Backup("vedbmbackupDemo", {
        instanceId: "vedbm-i34lvm3j***",
        backupType: "Full",
        backupMethod: "Physical",
        backupTime: "00:00Z-02:00Z",
        fullBackupPeriod: "Sunday",
        backupRetentionPeriod: 11,
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    vedbmbackup_demo = volcenginecc.vedbm.Backup("vedbmbackupDemo",
        instance_id="vedbm-i34lvm3j***",
        backup_type="Full",
        backup_method="Physical",
        backup_time="00:00Z-02:00Z",
        full_backup_period="Sunday",
        backup_retention_period=11)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vedbm"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vedbm.NewBackup(ctx, "vedbmbackupDemo", &vedbm.BackupArgs{
    			InstanceId:            pulumi.String("vedbm-i34lvm3j***"),
    			BackupType:            pulumi.String("Full"),
    			BackupMethod:          pulumi.String("Physical"),
    			BackupTime:            pulumi.String("00:00Z-02:00Z"),
    			FullBackupPeriod:      pulumi.String("Sunday"),
    			BackupRetentionPeriod: pulumi.Int(11),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var vedbmbackupDemo = new Volcenginecc.Vedbm.Backup("vedbmbackupDemo", new()
        {
            InstanceId = "vedbm-i34lvm3j***",
            BackupType = "Full",
            BackupMethod = "Physical",
            BackupTime = "00:00Z-02:00Z",
            FullBackupPeriod = "Sunday",
            BackupRetentionPeriod = 11,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.vedbm.Backup;
    import com.volcengine.volcenginecc.vedbm.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) {
            var vedbmbackupDemo = new Backup("vedbmbackupDemo", BackupArgs.builder()
                .instanceId("vedbm-i34lvm3j***")
                .backupType("Full")
                .backupMethod("Physical")
                .backupTime("00:00Z-02:00Z")
                .fullBackupPeriod("Sunday")
                .backupRetentionPeriod(11)
                .build());
    
        }
    }
    
    resources:
      vedbmbackupDemo:
        type: volcenginecc:vedbm:Backup
        properties:
          instanceId: vedbm-i34lvm3j***
          backupType: Full
          backupMethod: Physical
          backupTime: 00:00Z-02:00Z
          fullBackupPeriod: Sunday
          backupRetentionPeriod: 11
    

    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_method: Optional[str] = None,
               backup_retention_period: Optional[int] = None,
               backup_time: Optional[str] = None,
               backup_type: Optional[str] = None,
               full_backup_period: 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: volcenginecc:vedbm: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 volcengineccBackupResource = new Volcenginecc.Vedbm.Backup("volcengineccBackupResource", new()
    {
        InstanceId = "string",
        BackupMethod = "string",
        BackupRetentionPeriod = 0,
        BackupTime = "string",
        BackupType = "string",
        FullBackupPeriod = "string",
    });
    
    example, err := vedbm.NewBackup(ctx, "volcengineccBackupResource", &vedbm.BackupArgs{
    	InstanceId:            pulumi.String("string"),
    	BackupMethod:          pulumi.String("string"),
    	BackupRetentionPeriod: pulumi.Int(0),
    	BackupTime:            pulumi.String("string"),
    	BackupType:            pulumi.String("string"),
    	FullBackupPeriod:      pulumi.String("string"),
    })
    
    var volcengineccBackupResource = new com.volcengine.volcenginecc.vedbm.Backup("volcengineccBackupResource", com.volcengine.volcenginecc.vedbm.BackupArgs.builder()
        .instanceId("string")
        .backupMethod("string")
        .backupRetentionPeriod(0)
        .backupTime("string")
        .backupType("string")
        .fullBackupPeriod("string")
        .build());
    
    volcenginecc_backup_resource = volcenginecc.vedbm.Backup("volcengineccBackupResource",
        instance_id="string",
        backup_method="string",
        backup_retention_period=0,
        backup_time="string",
        backup_type="string",
        full_backup_period="string")
    
    const volcengineccBackupResource = new volcenginecc.vedbm.Backup("volcengineccBackupResource", {
        instanceId: "string",
        backupMethod: "string",
        backupRetentionPeriod: 0,
        backupTime: "string",
        backupType: "string",
        fullBackupPeriod: "string",
    });
    
    type: volcenginecc:vedbm:Backup
    properties:
        backupMethod: string
        backupRetentionPeriod: 0
        backupTime: string
        backupType: string
        fullBackupPeriod: 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。
    BackupMethod string
    备份方式,目前仅支持物理备份。
    BackupRetentionPeriod int
    数据备份保留天数。
    BackupTime string
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    BackupType string
    备份类型,目前仅支持全量备份。
    FullBackupPeriod string
    全量备份周期,多个取值用英文逗号(,)隔开。
    InstanceId string
    实例ID。
    BackupMethod string
    备份方式,目前仅支持物理备份。
    BackupRetentionPeriod int
    数据备份保留天数。
    BackupTime string
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    BackupType string
    备份类型,目前仅支持全量备份。
    FullBackupPeriod string
    全量备份周期,多个取值用英文逗号(,)隔开。
    instanceId String
    实例ID。
    backupMethod String
    备份方式,目前仅支持物理备份。
    backupRetentionPeriod Integer
    数据备份保留天数。
    backupTime String
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    backupType String
    备份类型,目前仅支持全量备份。
    fullBackupPeriod String
    全量备份周期,多个取值用英文逗号(,)隔开。
    instanceId string
    实例ID。
    backupMethod string
    备份方式,目前仅支持物理备份。
    backupRetentionPeriod number
    数据备份保留天数。
    backupTime string
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    backupType string
    备份类型,目前仅支持全量备份。
    fullBackupPeriod string
    全量备份周期,多个取值用英文逗号(,)隔开。
    instance_id str
    实例ID。
    backup_method str
    备份方式,目前仅支持物理备份。
    backup_retention_period int
    数据备份保留天数。
    backup_time str
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    backup_type str
    备份类型,目前仅支持全量备份。
    full_backup_period str
    全量备份周期,多个取值用英文逗号(,)隔开。
    instanceId String
    实例ID。
    backupMethod String
    备份方式,目前仅支持物理备份。
    backupRetentionPeriod Number
    数据备份保留天数。
    backupTime String
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    backupType String
    备份类型,目前仅支持全量备份。
    fullBackupPeriod String
    全量备份周期,多个取值用英文逗号(,)隔开。

    Outputs

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

    BackupEndTime string
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    BackupFileSize int
    备份文件大小,单位为 KiB。
    BackupId string
    备份 ID。
    BackupStartTime string
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    BackupStatus string
    备份状态。
    ConsistentTime string
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    ContinueBackup bool
    是否开启持续备份,取值固定为 true。
    CreateType string
    创建类型。
    Id string
    The provider-assigned unique ID for this managed resource.
    BackupEndTime string
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    BackupFileSize int
    备份文件大小,单位为 KiB。
    BackupId string
    备份 ID。
    BackupStartTime string
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    BackupStatus string
    备份状态。
    ConsistentTime string
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    ContinueBackup bool
    是否开启持续备份,取值固定为 true。
    CreateType string
    创建类型。
    Id string
    The provider-assigned unique ID for this managed resource.
    backupEndTime String
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupFileSize Integer
    备份文件大小,单位为 KiB。
    backupId String
    备份 ID。
    backupStartTime String
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupStatus String
    备份状态。
    consistentTime String
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    continueBackup Boolean
    是否开启持续备份,取值固定为 true。
    createType String
    创建类型。
    id String
    The provider-assigned unique ID for this managed resource.
    backupEndTime string
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupFileSize number
    备份文件大小,单位为 KiB。
    backupId string
    备份 ID。
    backupStartTime string
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupStatus string
    备份状态。
    consistentTime string
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    continueBackup boolean
    是否开启持续备份,取值固定为 true。
    createType string
    创建类型。
    id string
    The provider-assigned unique ID for this managed resource.
    backup_end_time str
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backup_file_size int
    备份文件大小,单位为 KiB。
    backup_id str
    备份 ID。
    backup_start_time str
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backup_status str
    备份状态。
    consistent_time str
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    continue_backup bool
    是否开启持续备份,取值固定为 true。
    create_type str
    创建类型。
    id str
    The provider-assigned unique ID for this managed resource.
    backupEndTime String
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupFileSize Number
    备份文件大小,单位为 KiB。
    backupId String
    备份 ID。
    backupStartTime String
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupStatus String
    备份状态。
    consistentTime String
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    continueBackup Boolean
    是否开启持续备份,取值固定为 true。
    createType String
    创建类型。
    id String
    The provider-assigned unique ID for this managed resource.

    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_end_time: Optional[str] = None,
            backup_file_size: Optional[int] = None,
            backup_id: Optional[str] = None,
            backup_method: Optional[str] = None,
            backup_retention_period: Optional[int] = None,
            backup_start_time: Optional[str] = None,
            backup_status: Optional[str] = None,
            backup_time: Optional[str] = None,
            backup_type: Optional[str] = None,
            consistent_time: Optional[str] = None,
            continue_backup: Optional[bool] = None,
            create_type: Optional[str] = None,
            full_backup_period: Optional[str] = None,
            instance_id: Optional[str] = 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: volcenginecc:vedbm: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:
    BackupEndTime string
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    BackupFileSize int
    备份文件大小,单位为 KiB。
    BackupId string
    备份 ID。
    BackupMethod string
    备份方式,目前仅支持物理备份。
    BackupRetentionPeriod int
    数据备份保留天数。
    BackupStartTime string
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    BackupStatus string
    备份状态。
    BackupTime string
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    BackupType string
    备份类型,目前仅支持全量备份。
    ConsistentTime string
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    ContinueBackup bool
    是否开启持续备份,取值固定为 true。
    CreateType string
    创建类型。
    FullBackupPeriod string
    全量备份周期,多个取值用英文逗号(,)隔开。
    InstanceId string
    实例ID。
    BackupEndTime string
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    BackupFileSize int
    备份文件大小,单位为 KiB。
    BackupId string
    备份 ID。
    BackupMethod string
    备份方式,目前仅支持物理备份。
    BackupRetentionPeriod int
    数据备份保留天数。
    BackupStartTime string
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    BackupStatus string
    备份状态。
    BackupTime string
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    BackupType string
    备份类型,目前仅支持全量备份。
    ConsistentTime string
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    ContinueBackup bool
    是否开启持续备份,取值固定为 true。
    CreateType string
    创建类型。
    FullBackupPeriod string
    全量备份周期,多个取值用英文逗号(,)隔开。
    InstanceId string
    实例ID。
    backupEndTime String
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupFileSize Integer
    备份文件大小,单位为 KiB。
    backupId String
    备份 ID。
    backupMethod String
    备份方式,目前仅支持物理备份。
    backupRetentionPeriod Integer
    数据备份保留天数。
    backupStartTime String
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupStatus String
    备份状态。
    backupTime String
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    backupType String
    备份类型,目前仅支持全量备份。
    consistentTime String
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    continueBackup Boolean
    是否开启持续备份,取值固定为 true。
    createType String
    创建类型。
    fullBackupPeriod String
    全量备份周期,多个取值用英文逗号(,)隔开。
    instanceId String
    实例ID。
    backupEndTime string
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupFileSize number
    备份文件大小,单位为 KiB。
    backupId string
    备份 ID。
    backupMethod string
    备份方式,目前仅支持物理备份。
    backupRetentionPeriod number
    数据备份保留天数。
    backupStartTime string
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupStatus string
    备份状态。
    backupTime string
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    backupType string
    备份类型,目前仅支持全量备份。
    consistentTime string
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    continueBackup boolean
    是否开启持续备份,取值固定为 true。
    createType string
    创建类型。
    fullBackupPeriod string
    全量备份周期,多个取值用英文逗号(,)隔开。
    instanceId string
    实例ID。
    backup_end_time str
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backup_file_size int
    备份文件大小,单位为 KiB。
    backup_id str
    备份 ID。
    backup_method str
    备份方式,目前仅支持物理备份。
    backup_retention_period int
    数据备份保留天数。
    backup_start_time str
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backup_status str
    备份状态。
    backup_time str
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    backup_type str
    备份类型,目前仅支持全量备份。
    consistent_time str
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    continue_backup bool
    是否开启持续备份,取值固定为 true。
    create_type str
    创建类型。
    full_backup_period str
    全量备份周期,多个取值用英文逗号(,)隔开。
    instance_id str
    实例ID。
    backupEndTime String
    备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupFileSize Number
    备份文件大小,单位为 KiB。
    backupId String
    备份 ID。
    backupMethod String
    备份方式,目前仅支持物理备份。
    backupRetentionPeriod Number
    数据备份保留天数。
    backupStartTime String
    备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    backupStatus String
    备份状态。
    backupTime String
    执行备份任务的时间,间隔窗口为两小时。格式:HH:mmZ-HH:mmZ(UTC 时间)。
    backupType String
    备份类型,目前仅支持全量备份。
    consistentTime String
    一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
    continueBackup Boolean
    是否开启持续备份,取值固定为 true。
    createType String
    创建类型。
    fullBackupPeriod String
    全量备份周期,多个取值用英文逗号(,)隔开。
    instanceId String
    实例ID。

    Import

    $ pulumi import volcenginecc:vedbm/backup:Backup example "instance_id|backup_id"
    

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.28
    published on Thursday, Mar 26, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.