volcenginecc.cbr.BackupPlan

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

To enable automatic backup for backup sources, you can create a backup plan, associate backup sources and backup policies within the plan, specify backup storage space, and set backup data retention rules. After creating the backup plan, the system will automatically back up the specified sources in a unified manner according to the associated backup policy configuration

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  cBRBackupPlanDemo:
    type: volcenginecc:cbr:BackupPlan
    name: CBRBackupPlanDemo
    properties:
      name: CBRBackupPlanDemo
      policyId: policy-krn3z1wf9ubujxxxxx
      resourceLists:
        - resource_type: ECS
          resource_id: res-krn4bq3sctbwvxxxxx
          meta_information:
            vepfsMeta: ""
            ecsMeta: '{"AutoBackupAllAttachedVolumes":true,"VolumeList":[{"VolumeId":"vol-3wt6m9uygg4kgxxxxx","VolumeName":"emr-d6af13acb6966xxxxx-volume-1-2","VolumeType":"ESSD_FlexPL"},{"VolumeId":"vol-3wt6m9vh3a3qxxxxx","VolumeName":"emr-d6af13acb6966xxxxx-volume-2-2","VolumeType":"ESSD_FlexPL"}]}'

Create BackupPlan Resource

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

Constructor syntax

new BackupPlan(name: string, args: BackupPlanArgs, opts?: CustomResourceOptions);

@overload
def BackupPlan(resource_name: str,
               args: BackupPlanArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def BackupPlan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               name: Optional[str] = None,
               resource_lists: Optional[Sequence[BackupPlanResourceListArgs]] = None,
               policy_id: Optional[str] = None)

func NewBackupPlan(ctx *Context, name string, args BackupPlanArgs, opts ...ResourceOption) (*BackupPlan, error)

public BackupPlan(string name, BackupPlanArgs args, CustomResourceOptions? opts = null)

public BackupPlan(String name, BackupPlanArgs args)
public BackupPlan(String name, BackupPlanArgs args, CustomResourceOptions options)

type: volcenginecc:cbr:BackupPlan
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 BackupPlanArgs: 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 BackupPlanArgs: 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 BackupPlanArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BackupPlanArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BackupPlanArgs: 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 backupPlanResource = new Volcenginecc.Cbr.BackupPlan("backupPlanResource", new()
{
    Name = "string",
    ResourceLists = new[]
    {
        new Volcenginecc.Cbr.Inputs.BackupPlanResourceListArgs
        {
            MetaInformation = new Volcenginecc.Cbr.Inputs.BackupPlanResourceListMetaInformationArgs
            {
                EcsMeta = "string",
                VepfsMeta = "string",
            },
            ResourceId = "string",
            ResourceType = "string",
        },
    },
    PolicyId = "string",
});

example, err := cbr.NewBackupPlan(ctx, "backupPlanResource", &cbr.BackupPlanArgs{
	Name: pulumi.String("string"),
	ResourceLists: cbr.BackupPlanResourceListArray{
		&cbr.BackupPlanResourceListArgs{
			MetaInformation: &cbr.BackupPlanResourceListMetaInformationArgs{
				EcsMeta:   pulumi.String("string"),
				VepfsMeta: pulumi.String("string"),
			},
			ResourceId:   pulumi.String("string"),
			ResourceType: pulumi.String("string"),
		},
	},
	PolicyId: pulumi.String("string"),
})

var backupPlanResource = new BackupPlan("backupPlanResource", BackupPlanArgs.builder()
    .name("string")
    .resourceLists(BackupPlanResourceListArgs.builder()
        .metaInformation(BackupPlanResourceListMetaInformationArgs.builder()
            .ecsMeta("string")
            .vepfsMeta("string")
            .build())
        .resourceId("string")
        .resourceType("string")
        .build())
    .policyId("string")
    .build());

backup_plan_resource = volcenginecc.cbr.BackupPlan("backupPlanResource",
    name="string",
    resource_lists=[{
        "meta_information": {
            "ecs_meta": "string",
            "vepfs_meta": "string",
        },
        "resource_id": "string",
        "resource_type": "string",
    }],
    policy_id="string")

const backupPlanResource = new volcenginecc.cbr.BackupPlan("backupPlanResource", {
    name: "string",
    resourceLists: [{
        metaInformation: {
            ecsMeta: "string",
            vepfsMeta: "string",
        },
        resourceId: "string",
        resourceType: "string",
    }],
    policyId: "string",
});

type: volcenginecc:cbr:BackupPlan
properties:
    name: string
    policyId: string
    resourceLists:
        - metaInformation:
            ecsMeta: string
            vepfsMeta: string
          resourceId: string
          resourceType: string

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

Name string: Backup Plan Name
ResourceLists List<Volcengine.BackupPlanResourceList>
PolicyId string: Backup Policy ID

Name string: Backup Plan Name
ResourceLists []BackupPlanResourceListArgs
PolicyId string: Backup Policy ID

name String: Backup Plan Name
resourceLists List<BackupPlanResourceList>
policyId String: Backup Policy ID

name string: Backup Plan Name
resourceLists BackupPlanResourceList[]
policyId string: Backup Policy ID

name str: Backup Plan Name
resource_lists Sequence[BackupPlanResourceListArgs]
policy_id str: Backup Policy ID

name String: Backup Plan Name
resourceLists List<Property Map>
policyId String: Backup Policy ID

Outputs

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

AccountId string: Account ID that created this plan
CreatedTime string: Creation Time
Id string: The provider-assigned unique ID for this managed resource.
PlanId string: Backup Plan ID
Policy Volcengine.BackupPlanPolicy: Backup Policy
UpdatedTime string: Update Time

AccountId string: Account ID that created this plan
CreatedTime string: Creation Time
Id string: The provider-assigned unique ID for this managed resource.
PlanId string: Backup Plan ID
Policy BackupPlanPolicy: Backup Policy
UpdatedTime string: Update Time

accountId String: Account ID that created this plan
createdTime String: Creation Time
id String: The provider-assigned unique ID for this managed resource.
planId String: Backup Plan ID
policy BackupPlanPolicy: Backup Policy
updatedTime String: Update Time

accountId string: Account ID that created this plan
createdTime string: Creation Time
id string: The provider-assigned unique ID for this managed resource.
planId string: Backup Plan ID
policy BackupPlanPolicy: Backup Policy
updatedTime string: Update Time

account_id str: Account ID that created this plan
created_time str: Creation Time
id str: The provider-assigned unique ID for this managed resource.
plan_id str: Backup Plan ID
policy BackupPlanPolicy: Backup Policy
updated_time str: Update Time

accountId String: Account ID that created this plan
createdTime String: Creation Time
id String: The provider-assigned unique ID for this managed resource.
planId String: Backup Plan ID
policy Property Map: Backup Policy
updatedTime String: Update Time

Look up Existing BackupPlan Resource

Get an existing BackupPlan 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?: BackupPlanState, opts?: CustomResourceOptions): BackupPlan

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        created_time: Optional[str] = None,
        name: Optional[str] = None,
        plan_id: Optional[str] = None,
        policy: Optional[BackupPlanPolicyArgs] = None,
        policy_id: Optional[str] = None,
        resource_lists: Optional[Sequence[BackupPlanResourceListArgs]] = None,
        updated_time: Optional[str] = None) -> BackupPlan

func GetBackupPlan(ctx *Context, name string, id IDInput, state *BackupPlanState, opts ...ResourceOption) (*BackupPlan, error)

public static BackupPlan Get(string name, Input<string> id, BackupPlanState? state, CustomResourceOptions? opts = null)

public static BackupPlan get(String name, Output<String> id, BackupPlanState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:cbr:BackupPlan    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 plan
CreatedTime string: Creation Time
Name string: Backup Plan Name
PlanId string: Backup Plan ID
Policy Volcengine.BackupPlanPolicy: Backup Policy
PolicyId string: Backup Policy ID
ResourceLists List<Volcengine.BackupPlanResourceList>
UpdatedTime string: Update Time

AccountId string: Account ID that created this plan
CreatedTime string: Creation Time
Name string: Backup Plan Name
PlanId string: Backup Plan ID
Policy BackupPlanPolicyArgs: Backup Policy
PolicyId string: Backup Policy ID
ResourceLists []BackupPlanResourceListArgs
UpdatedTime string: Update Time

accountId String: Account ID that created this plan
createdTime String: Creation Time
name String: Backup Plan Name
planId String: Backup Plan ID
policy BackupPlanPolicy: Backup Policy
policyId String: Backup Policy ID
resourceLists List<BackupPlanResourceList>
updatedTime String: Update Time

accountId string: Account ID that created this plan
createdTime string: Creation Time
name string: Backup Plan Name
planId string: Backup Plan ID
policy BackupPlanPolicy: Backup Policy
policyId string: Backup Policy ID
resourceLists BackupPlanResourceList[]
updatedTime string: Update Time

account_id str: Account ID that created this plan
created_time str: Creation Time
name str: Backup Plan Name
plan_id str: Backup Plan ID
policy BackupPlanPolicyArgs: Backup Policy
policy_id str: Backup Policy ID
resource_lists Sequence[BackupPlanResourceListArgs]
updated_time str: Update Time

accountId String: Account ID that created this plan
createdTime String: Creation Time
name String: Backup Plan Name
planId String: Backup Plan ID
policy Property Map: Backup Policy
policyId String: Backup Policy ID
resourceLists List<Property Map>
updatedTime String: Update Time

Supporting Types

BackupPlanPolicy, BackupPlanPolicyArgs

AccountId string: Account ID that created this policy
BackupType string: Backup type. Options: FULL: Full backup. INCREMENTAL: Incremental backup
CreatedTime string: Creation Time
Crontab string: Specifies the backup schedule. Supports standard crontab expressions
EnablePolicy bool: Whether the policy is enabled. Options: true: Enable policy. false: Disable policy
Name string: Policy Name
PlanNumber int: Number of backup plans associated with this policy
PolicyId string: Backup Policy ID
RetentionDay int: Retention time for recovery points. -1 means retain indefinitely
UpdatedTime string: Update Time

AccountId string: Account ID that created this policy
BackupType string: Backup type. Options: FULL: Full backup. INCREMENTAL: Incremental backup
CreatedTime string: Creation Time
Crontab string: Specifies the backup schedule. Supports standard crontab expressions
EnablePolicy bool: Whether the policy is enabled. Options: true: Enable policy. false: Disable policy
Name string: Policy Name
PlanNumber int: Number of backup plans associated with this policy
PolicyId string: Backup Policy ID
RetentionDay int: Retention time for recovery points. -1 means retain indefinitely
UpdatedTime string: Update Time

accountId String: Account ID that created this policy
backupType String: Backup type. Options: FULL: Full backup. INCREMENTAL: Incremental backup
createdTime String: Creation Time
crontab String: Specifies the backup schedule. Supports standard crontab expressions
enablePolicy Boolean: Whether the policy is enabled. Options: true: Enable policy. false: Disable policy
name String: Policy Name
planNumber Integer: Number of backup plans associated with this policy
policyId String: Backup Policy ID
retentionDay Integer: Retention time for recovery points. -1 means retain indefinitely
updatedTime String: Update Time

accountId string: Account ID that created this policy
backupType string: Backup type. Options: FULL: Full backup. INCREMENTAL: Incremental backup
createdTime string: Creation Time
crontab string: Specifies the backup schedule. Supports standard crontab expressions
enablePolicy boolean: Whether the policy is enabled. Options: true: Enable policy. false: Disable policy
name string: Policy Name
planNumber number: Number of backup plans associated with this policy
policyId string: Backup Policy ID
retentionDay number: Retention time for recovery points. -1 means retain indefinitely
updatedTime string: Update Time

account_id str: Account ID that created this policy
backup_type str: Backup type. Options: FULL: Full backup. INCREMENTAL: Incremental backup
created_time str: Creation Time
crontab str: Specifies the backup schedule. Supports standard crontab expressions
enable_policy bool: Whether the policy is enabled. Options: true: Enable policy. false: Disable policy
name str: Policy Name
plan_number int: Number of backup plans associated with this policy
policy_id str: Backup Policy ID
retention_day int: Retention time for recovery points. -1 means retain indefinitely
updated_time str: Update Time

accountId String: Account ID that created this policy
backupType String: Backup type. Options: FULL: Full backup. INCREMENTAL: Incremental backup
createdTime String: Creation Time
crontab String: Specifies the backup schedule. Supports standard crontab expressions
enablePolicy Boolean: Whether the policy is enabled. Options: true: Enable policy. false: Disable policy
name String: Policy Name
planNumber Number: Number of backup plans associated with this policy
policyId String: Backup Policy ID
retentionDay Number: Retention time for recovery points. -1 means retain indefinitely
updatedTime String: Update Time

BackupPlanResourceList, BackupPlanResourceListArgs

MetaInformation Volcengine.BackupPlanResourceListMetaInformation: Resource meta information, used to store additional configuration when creating a backup plan
ResourceId string: Backup Source ID
ResourceType string: Backup source type. Options: ECS: ECS full machine backup. vePFS: vePFS file system backup

MetaInformation BackupPlanResourceListMetaInformation: Resource meta information, used to store additional configuration when creating a backup plan
ResourceId string: Backup Source ID
ResourceType string: Backup source type. Options: ECS: ECS full machine backup. vePFS: vePFS file system backup

metaInformation BackupPlanResourceListMetaInformation: Resource meta information, used to store additional configuration when creating a backup plan
resourceId String: Backup Source ID
resourceType String: Backup source type. Options: ECS: ECS full machine backup. vePFS: vePFS file system backup

metaInformation BackupPlanResourceListMetaInformation: Resource meta information, used to store additional configuration when creating a backup plan
resourceId string: Backup Source ID
resourceType string: Backup source type. Options: ECS: ECS full machine backup. vePFS: vePFS file system backup

meta_information BackupPlanResourceListMetaInformation: Resource meta information, used to store additional configuration when creating a backup plan
resource_id str: Backup Source ID
resource_type str: Backup source type. Options: ECS: ECS full machine backup. vePFS: vePFS file system backup

metaInformation Property Map: Resource meta information, used to store additional configuration when creating a backup plan
resourceId String: Backup Source ID
resourceType String: Backup source type. Options: ECS: ECS full machine backup. vePFS: vePFS file system backup

BackupPlanResourceListMetaInformation, BackupPlanResourceListMetaInformationArgs

EcsMeta string: ECS metadata, which is a JSON string
VepfsMeta string: vePFS backup source metadata, which is a JSON string

EcsMeta string: ECS metadata, which is a JSON string
VepfsMeta string: vePFS backup source metadata, which is a JSON string

ecsMeta String: ECS metadata, which is a JSON string
vepfsMeta String: vePFS backup source metadata, which is a JSON string

ecsMeta string: ECS metadata, which is a JSON string
vepfsMeta string: vePFS backup source metadata, which is a JSON string

ecs_meta str: ECS metadata, which is a JSON string
vepfs_meta str: vePFS backup source metadata, which is a JSON string

ecsMeta String: ECS metadata, which is a JSON string
vepfsMeta String: vePFS backup source metadata, which is a JSON string

Import

$ pulumi import volcenginecc:cbr/backupPlan:BackupPlan example "plan_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.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.cbr.BackupPlan

On this page

On this page

Example Usage

Create BackupPlan Resource

Constructor syntax

Parameters

Constructor example

BackupPlan Resource Properties

Inputs

Outputs

Look up Existing BackupPlan Resource

Supporting Types

BackupPlanPolicy, BackupPlanPolicyArgs

BackupPlanResourceList, BackupPlanResourceListArgs

BackupPlanResourceListMetaInformation, BackupPlanResourceListMetaInformationArgs

Import

Package Details

On this page

On this page