1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. vedbm
  5. Backup
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.vedbm.Backup

bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Cloud Database veDB Backup Management

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const vedbmbackupDemo = new bytepluscc.vedbm.Backup("vedbmbackupDemo", {
    instanceId: "vedbm-i34lvm3j***",
    backupType: "Full",
    backupMethod: "Physical",
    backupTime: "00:00Z-02:00Z",
    fullBackupPeriod: "Sunday",
    backupRetentionPeriod: 11,
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

vedbmbackup_demo = bytepluscc.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/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/vedbm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

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 Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var vedbmbackupDemo = new Bytepluscc.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.byteplus.bytepluscc.vedbm.Backup;
import com.byteplus.bytepluscc.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: bytepluscc: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: bytepluscc: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 byteplusccBackupResource = new Bytepluscc.Vedbm.Backup("byteplusccBackupResource", new()
{
    InstanceId = "string",
    BackupMethod = "string",
    BackupRetentionPeriod = 0,
    BackupTime = "string",
    BackupType = "string",
    FullBackupPeriod = "string",
});

    example, err := vedbm.NewBackup(ctx, "byteplusccBackupResource", &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 byteplusccBackupResource = new com.byteplus.bytepluscc.vedbm.Backup("byteplusccBackupResource", com.byteplus.bytepluscc.vedbm.BackupArgs.builder()
    .instanceId("string")
    .backupMethod("string")
    .backupRetentionPeriod(0)
    .backupTime("string")
    .backupType("string")
    .fullBackupPeriod("string")
    .build());

    bytepluscc_backup_resource = bytepluscc.vedbm.Backup("byteplusccBackupResource",
    instance_id="string",
    backup_method="string",
    backup_retention_period=0,
    backup_time="string",
    backup_type="string",
    full_backup_period="string")

    const byteplusccBackupResource = new bytepluscc.vedbm.Backup("byteplusccBackupResource", {
    instanceId: "string",
    backupMethod: "string",
    backupRetentionPeriod: 0,
    backupTime: "string",
    backupType: "string",
    fullBackupPeriod: "string",
});

    type: bytepluscc: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
    Instance ID
    BackupMethod string
    Backup method, currently only physical backup is supported
    BackupRetentionPeriod int
    Data backup retention days
    BackupTime string
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    BackupType string
    Backup type, currently only full backup is supported
    FullBackupPeriod string
    Full backup cycle, use commas (,) to separate multiple values
    InstanceId string
    Instance ID
    BackupMethod string
    Backup method, currently only physical backup is supported
    BackupRetentionPeriod int
    Data backup retention days
    BackupTime string
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    BackupType string
    Backup type, currently only full backup is supported
    FullBackupPeriod string
    Full backup cycle, use commas (,) to separate multiple values
    instanceId String
    Instance ID
    backupMethod String
    Backup method, currently only physical backup is supported
    backupRetentionPeriod Integer
    Data backup retention days
    backupTime String
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    backupType String
    Backup type, currently only full backup is supported
    fullBackupPeriod String
    Full backup cycle, use commas (,) to separate multiple values
    instanceId string
    Instance ID
    backupMethod string
    Backup method, currently only physical backup is supported
    backupRetentionPeriod number
    Data backup retention days
    backupTime string
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    backupType string
    Backup type, currently only full backup is supported
    fullBackupPeriod string
    Full backup cycle, use commas (,) to separate multiple values
    instance_id str
    Instance ID
    backup_method str
    Backup method, currently only physical backup is supported
    backup_retention_period int
    Data backup retention days
    backup_time str
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    backup_type str
    Backup type, currently only full backup is supported
    full_backup_period str
    Full backup cycle, use commas (,) to separate multiple values
    instanceId String
    Instance ID
    backupMethod String
    Backup method, currently only physical backup is supported
    backupRetentionPeriod Number
    Data backup retention days
    backupTime String
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    backupType String
    Backup type, currently only full backup is supported
    fullBackupPeriod String
    Full backup cycle, use commas (,) to separate multiple values

    Outputs

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

    BackupEndTime string
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    BackupFileSize int
    Backup file size, unit: KiB
    BackupId string
    Backup ID
    BackupStartTime string
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    BackupStatus string
    Backup status
    ConsistentTime string
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    ContinueBackup bool
    Enable continuous backup, value is always true
    CreateType string
    Creation type
    Id string
    The provider-assigned unique ID for this managed resource.
    BackupEndTime string
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    BackupFileSize int
    Backup file size, unit: KiB
    BackupId string
    Backup ID
    BackupStartTime string
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    BackupStatus string
    Backup status
    ConsistentTime string
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    ContinueBackup bool
    Enable continuous backup, value is always true
    CreateType string
    Creation type
    Id string
    The provider-assigned unique ID for this managed resource.
    backupEndTime String
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupFileSize Integer
    Backup file size, unit: KiB
    backupId String
    Backup ID
    backupStartTime String
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupStatus String
    Backup status
    consistentTime String
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    continueBackup Boolean
    Enable continuous backup, value is always true
    createType String
    Creation type
    id String
    The provider-assigned unique ID for this managed resource.
    backupEndTime string
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupFileSize number
    Backup file size, unit: KiB
    backupId string
    Backup ID
    backupStartTime string
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupStatus string
    Backup status
    consistentTime string
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    continueBackup boolean
    Enable continuous backup, value is always true
    createType string
    Creation type
    id string
    The provider-assigned unique ID for this managed resource.
    backup_end_time str
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backup_file_size int
    Backup file size, unit: KiB
    backup_id str
    Backup ID
    backup_start_time str
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backup_status str
    Backup status
    consistent_time str
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    continue_backup bool
    Enable continuous backup, value is always true
    create_type str
    Creation type
    id str
    The provider-assigned unique ID for this managed resource.
    backupEndTime String
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupFileSize Number
    Backup file size, unit: KiB
    backupId String
    Backup ID
    backupStartTime String
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupStatus String
    Backup status
    consistentTime String
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    continueBackup Boolean
    Enable continuous backup, value is always true
    createType String
    Creation type
    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: bytepluscc: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
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    BackupFileSize int
    Backup file size, unit: KiB
    BackupId string
    Backup ID
    BackupMethod string
    Backup method, currently only physical backup is supported
    BackupRetentionPeriod int
    Data backup retention days
    BackupStartTime string
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    BackupStatus string
    Backup status
    BackupTime string
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    BackupType string
    Backup type, currently only full backup is supported
    ConsistentTime string
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    ContinueBackup bool
    Enable continuous backup, value is always true
    CreateType string
    Creation type
    FullBackupPeriod string
    Full backup cycle, use commas (,) to separate multiple values
    InstanceId string
    Instance ID
    BackupEndTime string
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    BackupFileSize int
    Backup file size, unit: KiB
    BackupId string
    Backup ID
    BackupMethod string
    Backup method, currently only physical backup is supported
    BackupRetentionPeriod int
    Data backup retention days
    BackupStartTime string
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    BackupStatus string
    Backup status
    BackupTime string
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    BackupType string
    Backup type, currently only full backup is supported
    ConsistentTime string
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    ContinueBackup bool
    Enable continuous backup, value is always true
    CreateType string
    Creation type
    FullBackupPeriod string
    Full backup cycle, use commas (,) to separate multiple values
    InstanceId string
    Instance ID
    backupEndTime String
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupFileSize Integer
    Backup file size, unit: KiB
    backupId String
    Backup ID
    backupMethod String
    Backup method, currently only physical backup is supported
    backupRetentionPeriod Integer
    Data backup retention days
    backupStartTime String
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupStatus String
    Backup status
    backupTime String
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    backupType String
    Backup type, currently only full backup is supported
    consistentTime String
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    continueBackup Boolean
    Enable continuous backup, value is always true
    createType String
    Creation type
    fullBackupPeriod String
    Full backup cycle, use commas (,) to separate multiple values
    instanceId String
    Instance ID
    backupEndTime string
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupFileSize number
    Backup file size, unit: KiB
    backupId string
    Backup ID
    backupMethod string
    Backup method, currently only physical backup is supported
    backupRetentionPeriod number
    Data backup retention days
    backupStartTime string
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupStatus string
    Backup status
    backupTime string
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    backupType string
    Backup type, currently only full backup is supported
    consistentTime string
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    continueBackup boolean
    Enable continuous backup, value is always true
    createType string
    Creation type
    fullBackupPeriod string
    Full backup cycle, use commas (,) to separate multiple values
    instanceId string
    Instance ID
    backup_end_time str
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backup_file_size int
    Backup file size, unit: KiB
    backup_id str
    Backup ID
    backup_method str
    Backup method, currently only physical backup is supported
    backup_retention_period int
    Data backup retention days
    backup_start_time str
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backup_status str
    Backup status
    backup_time str
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    backup_type str
    Backup type, currently only full backup is supported
    consistent_time str
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    continue_backup bool
    Enable continuous backup, value is always true
    create_type str
    Creation type
    full_backup_period str
    Full backup cycle, use commas (,) to separate multiple values
    instance_id str
    Instance ID
    backupEndTime String
    Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupFileSize Number
    Backup file size, unit: KiB
    backupId String
    Backup ID
    backupMethod String
    Backup method, currently only physical backup is supported
    backupRetentionPeriod Number
    Data backup retention days
    backupStartTime String
    Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    backupStatus String
    Backup status
    backupTime String
    Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)
    backupType String
    Backup type, currently only full backup is supported
    consistentTime String
    Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
    continueBackup Boolean
    Enable continuous backup, value is always true
    createType String
    Creation type
    fullBackupPeriod String
    Full backup cycle, use commas (,) to separate multiple values
    instanceId String
    Instance ID

    Import

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

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.21
    published on Thursday, Apr 2, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.