1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. cbr
  5. BackupResource
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

    指备份对象,是云备份操作的起点。它可以是备份源产品中的计算资源、服务实例或者一组协同工作的服务和资源的集合,例如 ECS 整机、云盘、对象存储 Bucket。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const cBRBackupResourceDemo = new volcenginecc.cbr.BackupResource("CBRBackupResourceDemo", {
        instanceId: "i-yebwmo5pfkcva4xxxxx",
        instanceName: "CBRBackupResourceDemo",
        resourceType: "ECS",
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    c_br_backup_resource_demo = volcenginecc.cbr.BackupResource("CBRBackupResourceDemo",
        instance_id="i-yebwmo5pfkcva4xxxxx",
        instance_name="CBRBackupResourceDemo",
        resource_type="ECS")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cbr"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cbr.NewBackupResource(ctx, "CBRBackupResourceDemo", &cbr.BackupResourceArgs{
    			InstanceId:   pulumi.String("i-yebwmo5pfkcva4xxxxx"),
    			InstanceName: pulumi.String("CBRBackupResourceDemo"),
    			ResourceType: pulumi.String("ECS"),
    		})
    		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 cBRBackupResourceDemo = new Volcenginecc.Cbr.BackupResource("CBRBackupResourceDemo", new()
        {
            InstanceId = "i-yebwmo5pfkcva4xxxxx",
            InstanceName = "CBRBackupResourceDemo",
            ResourceType = "ECS",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.cbr.BackupResource;
    import com.volcengine.volcenginecc.cbr.BackupResourceArgs;
    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 cBRBackupResourceDemo = new BackupResource("cBRBackupResourceDemo", BackupResourceArgs.builder()
                .instanceId("i-yebwmo5pfkcva4xxxxx")
                .instanceName("CBRBackupResourceDemo")
                .resourceType("ECS")
                .build());
    
        }
    }
    
    resources:
      cBRBackupResourceDemo:
        type: volcenginecc:cbr:BackupResource
        name: CBRBackupResourceDemo
        properties:
          instanceId: i-yebwmo5pfkcva4xxxxx
          instanceName: CBRBackupResourceDemo
          resourceType: ECS
    

    Create BackupResource Resource

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

    Constructor syntax

    new BackupResource(name: string, args: BackupResourceArgs, opts?: CustomResourceOptions);
    @overload
    def BackupResource(resource_name: str,
                       args: BackupResourceArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def BackupResource(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       instance_id: Optional[str] = None,
                       instance_name: Optional[str] = None,
                       resource_type: Optional[str] = None,
                       meta_information: Optional[BackupResourceMetaInformationArgs] = None)
    func NewBackupResource(ctx *Context, name string, args BackupResourceArgs, opts ...ResourceOption) (*BackupResource, error)
    public BackupResource(string name, BackupResourceArgs args, CustomResourceOptions? opts = null)
    public BackupResource(String name, BackupResourceArgs args)
    public BackupResource(String name, BackupResourceArgs args, CustomResourceOptions options)
    
    type: volcenginecc:cbr:BackupResource
    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 BackupResourceArgs
    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 BackupResourceArgs
    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 BackupResourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupResourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupResourceArgs
    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 backupResourceResource = new Volcenginecc.Cbr.BackupResource("backupResourceResource", new()
    {
        InstanceId = "string",
        InstanceName = "string",
        ResourceType = "string",
        MetaInformation = new Volcenginecc.Cbr.Inputs.BackupResourceMetaInformationArgs
        {
            EcsMeta = "string",
            VepfsMeta = "string",
        },
    });
    
    example, err := cbr.NewBackupResource(ctx, "backupResourceResource", &cbr.BackupResourceArgs{
    	InstanceId:   pulumi.String("string"),
    	InstanceName: pulumi.String("string"),
    	ResourceType: pulumi.String("string"),
    	MetaInformation: &cbr.BackupResourceMetaInformationArgs{
    		EcsMeta:   pulumi.String("string"),
    		VepfsMeta: pulumi.String("string"),
    	},
    })
    
    var backupResourceResource = new BackupResource("backupResourceResource", BackupResourceArgs.builder()
        .instanceId("string")
        .instanceName("string")
        .resourceType("string")
        .metaInformation(BackupResourceMetaInformationArgs.builder()
            .ecsMeta("string")
            .vepfsMeta("string")
            .build())
        .build());
    
    backup_resource_resource = volcenginecc.cbr.BackupResource("backupResourceResource",
        instance_id="string",
        instance_name="string",
        resource_type="string",
        meta_information={
            "ecs_meta": "string",
            "vepfs_meta": "string",
        })
    
    const backupResourceResource = new volcenginecc.cbr.BackupResource("backupResourceResource", {
        instanceId: "string",
        instanceName: "string",
        resourceType: "string",
        metaInformation: {
            ecsMeta: "string",
            vepfsMeta: "string",
        },
    });
    
    type: volcenginecc:cbr:BackupResource
    properties:
        instanceId: string
        instanceName: string
        metaInformation:
            ecsMeta: string
            vepfsMeta: string
        resourceType: string
    

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

    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。
    ResourceType string
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    MetaInformation Volcengine.BackupResourceMetaInformation
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。
    ResourceType string
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    MetaInformation BackupResourceMetaInformationArgs
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。
    resourceType String
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    metaInformation BackupResourceMetaInformation
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    instanceId string
    实例 ID。
    instanceName string
    实例名称。
    resourceType string
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    metaInformation BackupResourceMetaInformation
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    instance_id str
    实例 ID。
    instance_name str
    实例名称。
    resource_type str
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    meta_information BackupResourceMetaInformationArgs
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。
    resourceType String
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    metaInformation Property Map
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。

    Outputs

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

    AccountId string
    创建此备份源的账户 ID。
    CreatedTime string
    创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    Plans List<Volcengine.BackupResourcePlan>
    RecoveryPointNumber int
    恢复点的数量
    ResourceId string
    备份源 ID。
    Status string
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    UpdatedTime string
    更新时间
    UsedCapacityInBytes int
    已经备份的字节数。
    AccountId string
    创建此备份源的账户 ID。
    CreatedTime string
    创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    Plans []BackupResourcePlan
    RecoveryPointNumber int
    恢复点的数量
    ResourceId string
    备份源 ID。
    Status string
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    UpdatedTime string
    更新时间
    UsedCapacityInBytes int
    已经备份的字节数。
    accountId String
    创建此备份源的账户 ID。
    createdTime String
    创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    plans List<BackupResourcePlan>
    recoveryPointNumber Integer
    恢复点的数量
    resourceId String
    备份源 ID。
    status String
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    updatedTime String
    更新时间
    usedCapacityInBytes Integer
    已经备份的字节数。
    accountId string
    创建此备份源的账户 ID。
    createdTime string
    创建时间。
    id string
    The provider-assigned unique ID for this managed resource.
    plans BackupResourcePlan[]
    recoveryPointNumber number
    恢复点的数量
    resourceId string
    备份源 ID。
    status string
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    updatedTime string
    更新时间
    usedCapacityInBytes number
    已经备份的字节数。
    account_id str
    创建此备份源的账户 ID。
    created_time str
    创建时间。
    id str
    The provider-assigned unique ID for this managed resource.
    plans Sequence[BackupResourcePlan]
    recovery_point_number int
    恢复点的数量
    resource_id str
    备份源 ID。
    status str
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    updated_time str
    更新时间
    used_capacity_in_bytes int
    已经备份的字节数。
    accountId String
    创建此备份源的账户 ID。
    createdTime String
    创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    plans List<Property Map>
    recoveryPointNumber Number
    恢复点的数量
    resourceId String
    备份源 ID。
    status String
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    updatedTime String
    更新时间
    usedCapacityInBytes Number
    已经备份的字节数。

    Look up Existing BackupResource Resource

    Get an existing BackupResource 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?: BackupResourceState, opts?: CustomResourceOptions): BackupResource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            created_time: Optional[str] = None,
            instance_id: Optional[str] = None,
            instance_name: Optional[str] = None,
            meta_information: Optional[BackupResourceMetaInformationArgs] = None,
            plans: Optional[Sequence[BackupResourcePlanArgs]] = None,
            recovery_point_number: Optional[int] = None,
            resource_id: Optional[str] = None,
            resource_type: Optional[str] = None,
            status: Optional[str] = None,
            updated_time: Optional[str] = None,
            used_capacity_in_bytes: Optional[int] = None) -> BackupResource
    func GetBackupResource(ctx *Context, name string, id IDInput, state *BackupResourceState, opts ...ResourceOption) (*BackupResource, error)
    public static BackupResource Get(string name, Input<string> id, BackupResourceState? state, CustomResourceOptions? opts = null)
    public static BackupResource get(String name, Output<String> id, BackupResourceState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:cbr:BackupResource    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。
    CreatedTime string
    创建时间。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。
    MetaInformation Volcengine.BackupResourceMetaInformation
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    Plans List<Volcengine.BackupResourcePlan>
    RecoveryPointNumber int
    恢复点的数量
    ResourceId string
    备份源 ID。
    ResourceType string
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    Status string
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    UpdatedTime string
    更新时间
    UsedCapacityInBytes int
    已经备份的字节数。
    AccountId string
    创建此备份源的账户 ID。
    CreatedTime string
    创建时间。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。
    MetaInformation BackupResourceMetaInformationArgs
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    Plans []BackupResourcePlanArgs
    RecoveryPointNumber int
    恢复点的数量
    ResourceId string
    备份源 ID。
    ResourceType string
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    Status string
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    UpdatedTime string
    更新时间
    UsedCapacityInBytes int
    已经备份的字节数。
    accountId String
    创建此备份源的账户 ID。
    createdTime String
    创建时间。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。
    metaInformation BackupResourceMetaInformation
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    plans List<BackupResourcePlan>
    recoveryPointNumber Integer
    恢复点的数量
    resourceId String
    备份源 ID。
    resourceType String
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    status String
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    updatedTime String
    更新时间
    usedCapacityInBytes Integer
    已经备份的字节数。
    accountId string
    创建此备份源的账户 ID。
    createdTime string
    创建时间。
    instanceId string
    实例 ID。
    instanceName string
    实例名称。
    metaInformation BackupResourceMetaInformation
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    plans BackupResourcePlan[]
    recoveryPointNumber number
    恢复点的数量
    resourceId string
    备份源 ID。
    resourceType string
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    status string
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    updatedTime string
    更新时间
    usedCapacityInBytes number
    已经备份的字节数。
    account_id str
    创建此备份源的账户 ID。
    created_time str
    创建时间。
    instance_id str
    实例 ID。
    instance_name str
    实例名称。
    meta_information BackupResourceMetaInformationArgs
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    plans Sequence[BackupResourcePlanArgs]
    recovery_point_number int
    恢复点的数量
    resource_id str
    备份源 ID。
    resource_type str
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    status str
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    updated_time str
    更新时间
    used_capacity_in_bytes int
    已经备份的字节数。
    accountId String
    创建此备份源的账户 ID。
    createdTime String
    创建时间。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。
    metaInformation Property Map
    资源的meta信息(创建备份计划时,用于存储额外的配置)ECS 整机备份参数:见 EcsBackupConfiguration 结构体。vePFS 备份参数:见 VePFSBackupConfiguration 结构体。
    plans List<Property Map>
    recoveryPointNumber Number
    恢复点的数量
    resourceId String
    备份源 ID。
    resourceType String
    备份源类型,取值说明如下:ECS:ECS 整机。vePFS:vePFS 文件系统。
    status String
    备份源状态。可能的值为:AVAILABLE、REMOVING、BEINGBACKEDUP、RECOVERING、CREATING、ERROR、UNAVAILABLE。
    updatedTime String
    更新时间
    usedCapacityInBytes Number
    已经备份的字节数。

    Supporting Types

    BackupResourceMetaInformation, BackupResourceMetaInformationArgs

    EcsMeta string
    ECS 的元数据,是一个 JSON string。格式见数据结构的 EcsBackupConfiguration 结构体。
    VepfsMeta string
    vePFS 备份源元数据,是一个 JSON string。格式见数据结构的VePFSBackupConfiguration 结构体。
    EcsMeta string
    ECS 的元数据,是一个 JSON string。格式见数据结构的 EcsBackupConfiguration 结构体。
    VepfsMeta string
    vePFS 备份源元数据,是一个 JSON string。格式见数据结构的VePFSBackupConfiguration 结构体。
    ecsMeta String
    ECS 的元数据,是一个 JSON string。格式见数据结构的 EcsBackupConfiguration 结构体。
    vepfsMeta String
    vePFS 备份源元数据,是一个 JSON string。格式见数据结构的VePFSBackupConfiguration 结构体。
    ecsMeta string
    ECS 的元数据,是一个 JSON string。格式见数据结构的 EcsBackupConfiguration 结构体。
    vepfsMeta string
    vePFS 备份源元数据,是一个 JSON string。格式见数据结构的VePFSBackupConfiguration 结构体。
    ecs_meta str
    ECS 的元数据,是一个 JSON string。格式见数据结构的 EcsBackupConfiguration 结构体。
    vepfs_meta str
    vePFS 备份源元数据,是一个 JSON string。格式见数据结构的VePFSBackupConfiguration 结构体。
    ecsMeta String
    ECS 的元数据,是一个 JSON string。格式见数据结构的 EcsBackupConfiguration 结构体。
    vepfsMeta String
    vePFS 备份源元数据,是一个 JSON string。格式见数据结构的VePFSBackupConfiguration 结构体。

    BackupResourcePlan, BackupResourcePlanArgs

    PlanId string
    备份计划 ID
    PlanName string
    备份计划名称
    PlanId string
    备份计划 ID
    PlanName string
    备份计划名称
    planId String
    备份计划 ID
    planName String
    备份计划名称
    planId string
    备份计划 ID
    planName string
    备份计划名称
    plan_id str
    备份计划 ID
    plan_name str
    备份计划名称
    planId String
    备份计划 ID
    planName String
    备份计划名称

    Import

    $ pulumi import volcenginecc:cbr/backupResource:BackupResource example "resource_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