1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. cbr
  5. BackupPolicy
volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine
volcenginecc logo
volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine

    备份策略中定义了备份周期、备份类型等信息。后续通过备份计划关联备份策略与备份存储空间,实现自动备份。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@pulumi/volcenginecc";
    
    const cBRBackupPolicyDemo = new volcenginecc.index.CbrBackuppolicy("CBRBackupPolicyDemo", {
        backupType: "INCREMENTAL",
        crontab: "0 2,1,0 * * 1,2",
        enablePolicy: false,
        name: "CBRBackupPolicyDemo",
        retentionDay: 67,
        retentionNumMax: -1,
        retentionNumMin: 2,
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    c_br_backup_policy_demo = volcenginecc.index.CbrBackuppolicy("CBRBackupPolicyDemo",
        backup_type=INCREMENTAL,
        crontab=0 2,1,0 * * 1,2,
        enable_policy=False,
        name=CBRBackupPolicyDemo,
        retention_day=67,
        retention_num_max=-1,
        retention_num_min=2)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := volcenginecc.NewCbrBackuppolicy(ctx, "CBRBackupPolicyDemo", &volcenginecc.CbrBackuppolicyArgs{
    			BackupType:      "INCREMENTAL",
    			Crontab:         "0 2,1,0 * * 1,2",
    			EnablePolicy:    false,
    			Name:            "CBRBackupPolicyDemo",
    			RetentionDay:    67,
    			RetentionNumMax: -1,
    			RetentionNumMin: 2,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var cBRBackupPolicyDemo = new Volcenginecc.Index.CbrBackuppolicy("CBRBackupPolicyDemo", new()
        {
            BackupType = "INCREMENTAL",
            Crontab = "0 2,1,0 * * 1,2",
            EnablePolicy = false,
            Name = "CBRBackupPolicyDemo",
            RetentionDay = 67,
            RetentionNumMax = -1,
            RetentionNumMin = 2,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcenginecc.cbrBackuppolicy;
    import com.pulumi.volcenginecc.cbrBackuppolicyArgs;
    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 cBRBackupPolicyDemo = new CbrBackuppolicy("cBRBackupPolicyDemo", CbrBackuppolicyArgs.builder()
                .backupType("INCREMENTAL")
                .crontab("0 2,1,0 * * 1,2")
                .enablePolicy(false)
                .name("CBRBackupPolicyDemo")
                .retentionDay(67)
                .retentionNumMax(-1)
                .retentionNumMin(2)
                .build());
    
        }
    }
    
    resources:
      cBRBackupPolicyDemo:
        type: volcenginecc:cbrBackuppolicy
        name: CBRBackupPolicyDemo
        properties:
          backupType: INCREMENTAL
          crontab: 0 2,1,0 * * 1,2
          enablePolicy: false
          name: CBRBackupPolicyDemo
          retentionDay: 67
          retentionNumMax: -1
          retentionNumMin: 2
    

    Create BackupPolicy Resource

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

    Constructor syntax

    new BackupPolicy(name: string, args: BackupPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def BackupPolicy(resource_name: str,
                     args: BackupPolicyArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def BackupPolicy(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     backup_type: Optional[str] = None,
                     crontab: Optional[str] = None,
                     enable_policy: Optional[bool] = None,
                     name: Optional[str] = None,
                     retention_day: Optional[int] = None,
                     retention_num_max: Optional[int] = None,
                     retention_num_min: Optional[int] = None)
    func NewBackupPolicy(ctx *Context, name string, args BackupPolicyArgs, opts ...ResourceOption) (*BackupPolicy, error)
    public BackupPolicy(string name, BackupPolicyArgs args, CustomResourceOptions? opts = null)
    public BackupPolicy(String name, BackupPolicyArgs args)
    public BackupPolicy(String name, BackupPolicyArgs args, CustomResourceOptions options)
    
    type: volcenginecc:cbr:BackupPolicy
    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 BackupPolicyArgs
    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 BackupPolicyArgs
    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 BackupPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupPolicyArgs
    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 backupPolicyResource = new Volcenginecc.Cbr.BackupPolicy("backupPolicyResource", new()
    {
        BackupType = "string",
        Crontab = "string",
        EnablePolicy = false,
        Name = "string",
        RetentionDay = 0,
        RetentionNumMax = 0,
        RetentionNumMin = 0,
    });
    
    example, err := cbr.NewBackupPolicy(ctx, "backupPolicyResource", &cbr.BackupPolicyArgs{
    	BackupType:      pulumi.String("string"),
    	Crontab:         pulumi.String("string"),
    	EnablePolicy:    pulumi.Bool(false),
    	Name:            pulumi.String("string"),
    	RetentionDay:    pulumi.Int(0),
    	RetentionNumMax: pulumi.Int(0),
    	RetentionNumMin: pulumi.Int(0),
    })
    
    var backupPolicyResource = new BackupPolicy("backupPolicyResource", BackupPolicyArgs.builder()
        .backupType("string")
        .crontab("string")
        .enablePolicy(false)
        .name("string")
        .retentionDay(0)
        .retentionNumMax(0)
        .retentionNumMin(0)
        .build());
    
    backup_policy_resource = volcenginecc.cbr.BackupPolicy("backupPolicyResource",
        backup_type="string",
        crontab="string",
        enable_policy=False,
        name="string",
        retention_day=0,
        retention_num_max=0,
        retention_num_min=0)
    
    const backupPolicyResource = new volcenginecc.cbr.BackupPolicy("backupPolicyResource", {
        backupType: "string",
        crontab: "string",
        enablePolicy: false,
        name: "string",
        retentionDay: 0,
        retentionNumMax: 0,
        retentionNumMin: 0,
    });
    
    type: volcenginecc:cbr:BackupPolicy
    properties:
        backupType: string
        crontab: string
        enablePolicy: false
        name: string
        retentionDay: 0
        retentionNumMax: 0
        retentionNumMin: 0
    

    BackupPolicy 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 BackupPolicy resource accepts the following input properties:

    BackupType string
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    Crontab string
    备份周期,采用 crontab 表达式。
    EnablePolicy bool
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    Name string
    策略名称。
    RetentionDay int
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    RetentionNumMax int
    最大恢复点保留数量。
    RetentionNumMin int
    最小恢复点保留数量下限。
    BackupType string
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    Crontab string
    备份周期,采用 crontab 表达式。
    EnablePolicy bool
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    Name string
    策略名称。
    RetentionDay int
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    RetentionNumMax int
    最大恢复点保留数量。
    RetentionNumMin int
    最小恢复点保留数量下限。
    backupType String
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    crontab String
    备份周期,采用 crontab 表达式。
    enablePolicy Boolean
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    name String
    策略名称。
    retentionDay Integer
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    retentionNumMax Integer
    最大恢复点保留数量。
    retentionNumMin Integer
    最小恢复点保留数量下限。
    backupType string
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    crontab string
    备份周期,采用 crontab 表达式。
    enablePolicy boolean
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    name string
    策略名称。
    retentionDay number
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    retentionNumMax number
    最大恢复点保留数量。
    retentionNumMin number
    最小恢复点保留数量下限。
    backup_type str
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    crontab str
    备份周期,采用 crontab 表达式。
    enable_policy bool
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    name str
    策略名称。
    retention_day int
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    retention_num_max int
    最大恢复点保留数量。
    retention_num_min int
    最小恢复点保留数量下限。
    backupType String
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    crontab String
    备份周期,采用 crontab 表达式。
    enablePolicy Boolean
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    name String
    策略名称。
    retentionDay Number
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    retentionNumMax Number
    最大恢复点保留数量。
    retentionNumMin Number
    最小恢复点保留数量下限。

    Outputs

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

    AccountId string
    创建此策略的账户 ID。
    CreatedTime string
    创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    PlanNumber int
    该策略已关联的备份计划数量。
    PolicyId string
    备份策略 ID。
    UpdatedTime string
    更新时间。
    AccountId string
    创建此策略的账户 ID。
    CreatedTime string
    创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    PlanNumber int
    该策略已关联的备份计划数量。
    PolicyId string
    备份策略 ID。
    UpdatedTime string
    更新时间。
    accountId String
    创建此策略的账户 ID。
    createdTime String
    创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    planNumber Integer
    该策略已关联的备份计划数量。
    policyId String
    备份策略 ID。
    updatedTime String
    更新时间。
    accountId string
    创建此策略的账户 ID。
    createdTime string
    创建时间。
    id string
    The provider-assigned unique ID for this managed resource.
    planNumber number
    该策略已关联的备份计划数量。
    policyId string
    备份策略 ID。
    updatedTime string
    更新时间。
    account_id str
    创建此策略的账户 ID。
    created_time str
    创建时间。
    id str
    The provider-assigned unique ID for this managed resource.
    plan_number int
    该策略已关联的备份计划数量。
    policy_id str
    备份策略 ID。
    updated_time str
    更新时间。
    accountId String
    创建此策略的账户 ID。
    createdTime String
    创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    planNumber Number
    该策略已关联的备份计划数量。
    policyId String
    备份策略 ID。
    updatedTime String
    更新时间。

    Look up Existing BackupPolicy Resource

    Get an existing BackupPolicy 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?: BackupPolicyState, opts?: CustomResourceOptions): BackupPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            backup_type: Optional[str] = None,
            created_time: Optional[str] = None,
            crontab: Optional[str] = None,
            enable_policy: Optional[bool] = None,
            name: Optional[str] = None,
            plan_number: Optional[int] = None,
            policy_id: Optional[str] = None,
            retention_day: Optional[int] = None,
            retention_num_max: Optional[int] = None,
            retention_num_min: Optional[int] = None,
            updated_time: Optional[str] = None) -> BackupPolicy
    func GetBackupPolicy(ctx *Context, name string, id IDInput, state *BackupPolicyState, opts ...ResourceOption) (*BackupPolicy, error)
    public static BackupPolicy Get(string name, Input<string> id, BackupPolicyState? state, CustomResourceOptions? opts = null)
    public static BackupPolicy get(String name, Output<String> id, BackupPolicyState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:cbr:BackupPolicy    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:
    AccountId string
    创建此策略的账户 ID。
    BackupType string
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    CreatedTime string
    创建时间。
    Crontab string
    备份周期,采用 crontab 表达式。
    EnablePolicy bool
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    Name string
    策略名称。
    PlanNumber int
    该策略已关联的备份计划数量。
    PolicyId string
    备份策略 ID。
    RetentionDay int
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    RetentionNumMax int
    最大恢复点保留数量。
    RetentionNumMin int
    最小恢复点保留数量下限。
    UpdatedTime string
    更新时间。
    AccountId string
    创建此策略的账户 ID。
    BackupType string
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    CreatedTime string
    创建时间。
    Crontab string
    备份周期,采用 crontab 表达式。
    EnablePolicy bool
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    Name string
    策略名称。
    PlanNumber int
    该策略已关联的备份计划数量。
    PolicyId string
    备份策略 ID。
    RetentionDay int
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    RetentionNumMax int
    最大恢复点保留数量。
    RetentionNumMin int
    最小恢复点保留数量下限。
    UpdatedTime string
    更新时间。
    accountId String
    创建此策略的账户 ID。
    backupType String
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    createdTime String
    创建时间。
    crontab String
    备份周期,采用 crontab 表达式。
    enablePolicy Boolean
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    name String
    策略名称。
    planNumber Integer
    该策略已关联的备份计划数量。
    policyId String
    备份策略 ID。
    retentionDay Integer
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    retentionNumMax Integer
    最大恢复点保留数量。
    retentionNumMin Integer
    最小恢复点保留数量下限。
    updatedTime String
    更新时间。
    accountId string
    创建此策略的账户 ID。
    backupType string
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    createdTime string
    创建时间。
    crontab string
    备份周期,采用 crontab 表达式。
    enablePolicy boolean
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    name string
    策略名称。
    planNumber number
    该策略已关联的备份计划数量。
    policyId string
    备份策略 ID。
    retentionDay number
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    retentionNumMax number
    最大恢复点保留数量。
    retentionNumMin number
    最小恢复点保留数量下限。
    updatedTime string
    更新时间。
    account_id str
    创建此策略的账户 ID。
    backup_type str
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    created_time str
    创建时间。
    crontab str
    备份周期,采用 crontab 表达式。
    enable_policy bool
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    name str
    策略名称。
    plan_number int
    该策略已关联的备份计划数量。
    policy_id str
    备份策略 ID。
    retention_day int
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    retention_num_max int
    最大恢复点保留数量。
    retention_num_min int
    最小恢复点保留数量下限。
    updated_time str
    更新时间。
    accountId String
    创建此策略的账户 ID。
    backupType String
    备份类型,取值说明如下:FULL:全量备份。INCREMENTAL:增量备份。
    createdTime String
    创建时间。
    crontab String
    备份周期,采用 crontab 表达式。
    enablePolicy Boolean
    策略是否启用,取值说明如下:true:启用策略。false:禁用策略。
    name String
    策略名称。
    planNumber Number
    该策略已关联的备份计划数量。
    policyId String
    备份策略 ID。
    retentionDay Number
    恢复点保留时间,-1 表示持续保留。其它合法取值的范围是[1, 999999]
    retentionNumMax Number
    最大恢复点保留数量。
    retentionNumMin Number
    最小恢复点保留数量下限。
    updatedTime String
    更新时间。

    Import

    $ pulumi import volcenginecc:cbr/backupPolicy:BackupPolicy example "policy_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
    volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine
      Meet Neo: Your AI Platform Teammate