1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. cbr
  6. getBackupPlan
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::CBR::BackupPlan

    Using getBackupPlan

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBackupPlan(args: GetBackupPlanArgs, opts?: InvokeOptions): Promise<GetBackupPlanResult>
    function getBackupPlanOutput(args: GetBackupPlanOutputArgs, opts?: InvokeOptions): Output<GetBackupPlanResult>
    def get_backup_plan(id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetBackupPlanResult
    def get_backup_plan_output(id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetBackupPlanResult]
    func LookupBackupPlan(ctx *Context, args *LookupBackupPlanArgs, opts ...InvokeOption) (*LookupBackupPlanResult, error)
    func LookupBackupPlanOutput(ctx *Context, args *LookupBackupPlanOutputArgs, opts ...InvokeOption) LookupBackupPlanResultOutput

    > Note: This function is named LookupBackupPlan in the Go SDK.

    public static class GetBackupPlan 
    {
        public static Task<GetBackupPlanResult> InvokeAsync(GetBackupPlanArgs args, InvokeOptions? opts = null)
        public static Output<GetBackupPlanResult> Invoke(GetBackupPlanInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBackupPlanResult> getBackupPlan(GetBackupPlanArgs args, InvokeOptions options)
    public static Output<GetBackupPlanResult> getBackupPlan(GetBackupPlanArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:cbr/getBackupPlan:getBackupPlan
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getBackupPlan Result

    The following output properties are available:

    AccountId string
    Account ID that created this plan
    CreatedTime string
    Creation Time
    Id string
    Uniquely identifies the resource.
    Name string
    Backup Plan Name
    PlanId string
    Backup Plan ID
    Policy Volcengine.GetBackupPlanPolicy
    Backup Policy
    PolicyId string
    Backup Policy ID
    ResourceLists List<Volcengine.GetBackupPlanResourceList>
    Backup Source List
    UpdatedTime string
    Update Time
    AccountId string
    Account ID that created this plan
    CreatedTime string
    Creation Time
    Id string
    Uniquely identifies the resource.
    Name string
    Backup Plan Name
    PlanId string
    Backup Plan ID
    Policy GetBackupPlanPolicy
    Backup Policy
    PolicyId string
    Backup Policy ID
    ResourceLists []GetBackupPlanResourceList
    Backup Source List
    UpdatedTime string
    Update Time
    accountId String
    Account ID that created this plan
    createdTime String
    Creation Time
    id String
    Uniquely identifies the resource.
    name String
    Backup Plan Name
    planId String
    Backup Plan ID
    policy GetBackupPlanPolicy
    Backup Policy
    policyId String
    Backup Policy ID
    resourceLists List<GetBackupPlanResourceList>
    Backup Source List
    updatedTime String
    Update Time
    accountId string
    Account ID that created this plan
    createdTime string
    Creation Time
    id string
    Uniquely identifies the resource.
    name string
    Backup Plan Name
    planId string
    Backup Plan ID
    policy GetBackupPlanPolicy
    Backup Policy
    policyId string
    Backup Policy ID
    resourceLists GetBackupPlanResourceList[]
    Backup Source List
    updatedTime string
    Update Time
    account_id str
    Account ID that created this plan
    created_time str
    Creation Time
    id str
    Uniquely identifies the resource.
    name str
    Backup Plan Name
    plan_id str
    Backup Plan ID
    policy GetBackupPlanPolicy
    Backup Policy
    policy_id str
    Backup Policy ID
    resource_lists Sequence[GetBackupPlanResourceList]
    Backup Source List
    updated_time str
    Update Time
    accountId String
    Account ID that created this plan
    createdTime String
    Creation Time
    id String
    Uniquely identifies the resource.
    name String
    Backup Plan Name
    planId String
    Backup Plan ID
    policy Property Map
    Backup Policy
    policyId String
    Backup Policy ID
    resourceLists List<Property Map>
    Backup Source List
    updatedTime String
    Update Time

    Supporting Types

    GetBackupPlanPolicy

    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

    GetBackupPlanResourceList

    MetaInformation Volcengine.GetBackupPlanResourceListMetaInformation
    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 GetBackupPlanResourceListMetaInformation
    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 GetBackupPlanResourceListMetaInformation
    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 GetBackupPlanResourceListMetaInformation
    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 GetBackupPlanResourceListMetaInformation
    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

    GetBackupPlanResourceListMetaInformation

    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

    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
      Try Pulumi Cloud free. Your team will thank you.