1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. cbr
  6. BackupResource
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.cbr.BackupResource

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Refers to the backup object, which is the starting point for cloud backup operations. It can be a computing resource, service instance, or a group of collaborative services and resources from the backup source product, such as ECS full instance, cloud disk, or object storage 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)
    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",
});

    example, err := cbr.NewBackupResource(ctx, "backupResourceResource", &cbr.BackupResourceArgs{
	InstanceId:   pulumi.String("string"),
	InstanceName: pulumi.String("string"),
	ResourceType: pulumi.String("string"),
})

    var backupResourceResource = new BackupResource("backupResourceResource", BackupResourceArgs.builder()
    .instanceId("string")
    .instanceName("string")
    .resourceType("string")
    .build());

    backup_resource_resource = volcenginecc.cbr.BackupResource("backupResourceResource",
    instance_id="string",
    instance_name="string",
    resource_type="string")

    const backupResourceResource = new volcenginecc.cbr.BackupResource("backupResourceResource", {
    instanceId: "string",
    instanceName: "string",
    resourceType: "string",
});

    type: volcenginecc:cbr:BackupResource
properties:
    instanceId: string
    instanceName: 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
    Instance ID
    InstanceName string
    Instance Name
    ResourceType string
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    InstanceId string
    Instance ID
    InstanceName string
    Instance Name
    ResourceType string
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    instanceId String
    Instance ID
    instanceName String
    Instance Name
    resourceType String
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    instanceId string
    Instance ID
    instanceName string
    Instance Name
    resourceType string
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    instance_id str
    Instance ID
    instance_name str
    Instance Name
    resource_type str
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    instanceId String
    Instance ID
    instanceName String
    Instance Name
    resourceType String
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.

    Outputs

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

    AccountId string
    Account ID that created this backup source
    CreatedTime string
    Creation Time
    Id string
    The provider-assigned unique ID for this managed resource.
    MetaInformation Volcengine.BackupResourceMetaInformation
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    Plans List<Volcengine.BackupResourcePlan>
    RecoveryPointNumber int
    Number of Restore Points
    ResourceId string
    Backup Source ID
    Status string
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    UpdatedTime string
    Update Time
    UsedCapacityInBytes int
    Bytes Already Backed Up
    AccountId string
    Account ID that created this backup source
    CreatedTime string
    Creation Time
    Id string
    The provider-assigned unique ID for this managed resource.
    MetaInformation BackupResourceMetaInformation
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    Plans []BackupResourcePlan
    RecoveryPointNumber int
    Number of Restore Points
    ResourceId string
    Backup Source ID
    Status string
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    UpdatedTime string
    Update Time
    UsedCapacityInBytes int
    Bytes Already Backed Up
    accountId String
    Account ID that created this backup source
    createdTime String
    Creation Time
    id String
    The provider-assigned unique ID for this managed resource.
    metaInformation BackupResourceMetaInformation
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    plans List<BackupResourcePlan>
    recoveryPointNumber Integer
    Number of Restore Points
    resourceId String
    Backup Source ID
    status String
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    updatedTime String
    Update Time
    usedCapacityInBytes Integer
    Bytes Already Backed Up
    accountId string
    Account ID that created this backup source
    createdTime string
    Creation Time
    id string
    The provider-assigned unique ID for this managed resource.
    metaInformation BackupResourceMetaInformation
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    plans BackupResourcePlan[]
    recoveryPointNumber number
    Number of Restore Points
    resourceId string
    Backup Source ID
    status string
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    updatedTime string
    Update Time
    usedCapacityInBytes number
    Bytes Already Backed Up
    account_id str
    Account ID that created this backup source
    created_time str
    Creation Time
    id str
    The provider-assigned unique ID for this managed resource.
    meta_information BackupResourceMetaInformation
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    plans Sequence[BackupResourcePlan]
    recovery_point_number int
    Number of Restore Points
    resource_id str
    Backup Source ID
    status str
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    updated_time str
    Update Time
    used_capacity_in_bytes int
    Bytes Already Backed Up
    accountId String
    Account ID that created this backup source
    createdTime String
    Creation Time
    id String
    The provider-assigned unique ID for this managed resource.
    metaInformation Property Map
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    plans List<Property Map>
    recoveryPointNumber Number
    Number of Restore Points
    resourceId String
    Backup Source ID
    status String
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    updatedTime String
    Update Time
    usedCapacityInBytes Number
    Bytes Already Backed Up

    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
    Account ID that created this backup source
    CreatedTime string
    Creation Time
    InstanceId string
    Instance ID
    InstanceName string
    Instance Name
    MetaInformation Volcengine.BackupResourceMetaInformation
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    Plans List<Volcengine.BackupResourcePlan>
    RecoveryPointNumber int
    Number of Restore Points
    ResourceId string
    Backup Source ID
    ResourceType string
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    Status string
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    UpdatedTime string
    Update Time
    UsedCapacityInBytes int
    Bytes Already Backed Up
    AccountId string
    Account ID that created this backup source
    CreatedTime string
    Creation Time
    InstanceId string
    Instance ID
    InstanceName string
    Instance Name
    MetaInformation BackupResourceMetaInformationArgs
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    Plans []BackupResourcePlanArgs
    RecoveryPointNumber int
    Number of Restore Points
    ResourceId string
    Backup Source ID
    ResourceType string
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    Status string
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    UpdatedTime string
    Update Time
    UsedCapacityInBytes int
    Bytes Already Backed Up
    accountId String
    Account ID that created this backup source
    createdTime String
    Creation Time
    instanceId String
    Instance ID
    instanceName String
    Instance Name
    metaInformation BackupResourceMetaInformation
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    plans List<BackupResourcePlan>
    recoveryPointNumber Integer
    Number of Restore Points
    resourceId String
    Backup Source ID
    resourceType String
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    status String
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    updatedTime String
    Update Time
    usedCapacityInBytes Integer
    Bytes Already Backed Up
    accountId string
    Account ID that created this backup source
    createdTime string
    Creation Time
    instanceId string
    Instance ID
    instanceName string
    Instance Name
    metaInformation BackupResourceMetaInformation
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    plans BackupResourcePlan[]
    recoveryPointNumber number
    Number of Restore Points
    resourceId string
    Backup Source ID
    resourceType string
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    status string
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    updatedTime string
    Update Time
    usedCapacityInBytes number
    Bytes Already Backed Up
    account_id str
    Account ID that created this backup source
    created_time str
    Creation Time
    instance_id str
    Instance ID
    instance_name str
    Instance Name
    meta_information BackupResourceMetaInformationArgs
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    plans Sequence[BackupResourcePlanArgs]
    recovery_point_number int
    Number of Restore Points
    resource_id str
    Backup Source ID
    resource_type str
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    status str
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    updated_time str
    Update Time
    used_capacity_in_bytes int
    Bytes Already Backed Up
    accountId String
    Account ID that created this backup source
    createdTime String
    Creation Time
    instanceId String
    Instance ID
    instanceName String
    Instance Name
    metaInformation Property Map
    Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.
    plans List<Property Map>
    recoveryPointNumber Number
    Number of Restore Points
    resourceId String
    Backup Source ID
    resourceType String
    Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.
    status String
    Backup source status. Possible values: AVAILABLE, REMOVING, BEINGBACKEDUP, RECOVERING, CREATING, ERROR, UNAVAILABLE.
    updatedTime String
    Update Time
    usedCapacityInBytes Number
    Bytes Already Backed Up

    Supporting Types

    BackupResourceMetaInformation, BackupResourceMetaInformationArgs

    EcsMeta string
    ECS metadata, as a JSON string. For format, see the EcsBackupConfiguration structure in the data structure.
    VepfsMeta string
    vePFS backup source metadata, as a JSON string. For format, see the VePFSBackupConfiguration structure in the data structure.
    EcsMeta string
    ECS metadata, as a JSON string. For format, see the EcsBackupConfiguration structure in the data structure.
    VepfsMeta string
    vePFS backup source metadata, as a JSON string. For format, see the VePFSBackupConfiguration structure in the data structure.
    ecsMeta String
    ECS metadata, as a JSON string. For format, see the EcsBackupConfiguration structure in the data structure.
    vepfsMeta String
    vePFS backup source metadata, as a JSON string. For format, see the VePFSBackupConfiguration structure in the data structure.
    ecsMeta string
    ECS metadata, as a JSON string. For format, see the EcsBackupConfiguration structure in the data structure.
    vepfsMeta string
    vePFS backup source metadata, as a JSON string. For format, see the VePFSBackupConfiguration structure in the data structure.
    ecs_meta str
    ECS metadata, as a JSON string. For format, see the EcsBackupConfiguration structure in the data structure.
    vepfs_meta str
    vePFS backup source metadata, as a JSON string. For format, see the VePFSBackupConfiguration structure in the data structure.
    ecsMeta String
    ECS metadata, as a JSON string. For format, see the EcsBackupConfiguration structure in the data structure.
    vepfsMeta String
    vePFS backup source metadata, as a JSON string. For format, see the VePFSBackupConfiguration structure in the data structure.

    BackupResourcePlan, BackupResourcePlanArgs

    PlanId string
    Backup Plan ID
    PlanName string
    Backup Plan Name
    PlanId string
    Backup Plan ID
    PlanName string
    Backup Plan Name
    planId String
    Backup Plan ID
    planName String
    Backup Plan Name
    planId string
    Backup Plan ID
    planName string
    Backup Plan Name
    plan_id str
    Backup Plan ID
    plan_name str
    Backup Plan Name
    planId String
    Backup Plan ID
    planName String
    Backup Plan Name

    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
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.