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

    Using getBackupPolicy

    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 getBackupPolicy(args: GetBackupPolicyArgs, opts?: InvokeOptions): Promise<GetBackupPolicyResult>
    function getBackupPolicyOutput(args: GetBackupPolicyOutputArgs, opts?: InvokeOptions): Output<GetBackupPolicyResult>
    def get_backup_policy(id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetBackupPolicyResult
    def get_backup_policy_output(id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetBackupPolicyResult]
    func LookupBackupPolicy(ctx *Context, args *LookupBackupPolicyArgs, opts ...InvokeOption) (*LookupBackupPolicyResult, error)
    func LookupBackupPolicyOutput(ctx *Context, args *LookupBackupPolicyOutputArgs, opts ...InvokeOption) LookupBackupPolicyResultOutput

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

    public static class GetBackupPolicy 
    {
        public static Task<GetBackupPolicyResult> InvokeAsync(GetBackupPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetBackupPolicyResult> Invoke(GetBackupPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBackupPolicyResult> getBackupPolicy(GetBackupPolicyArgs args, InvokeOptions options)
    public static Output<GetBackupPolicyResult> getBackupPolicy(GetBackupPolicyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:cbr/getBackupPolicy:getBackupPolicy
      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.

    getBackupPolicy Result

    The following output properties are available:

    AccountId string
    Account ID that created this policy
    BackupType string
    Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup
    CreatedTime string
    Creation time
    Crontab string
    Backup cycle, using a crontab expression
    EnablePolicy bool
    Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled
    Id string
    Uniquely identifies the resource.
    Name string
    Policy Name
    PlanNumber int
    Number of backup plans associated with this policy
    PolicyId string
    Backup Policy ID
    RetentionDay int
    Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]
    RetentionNumMax int
    Maximum number of restore points retained
    RetentionNumMin int
    Minimum restore point retention limit
    UpdatedTime string
    Update time
    AccountId string
    Account ID that created this policy
    BackupType string
    Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup
    CreatedTime string
    Creation time
    Crontab string
    Backup cycle, using a crontab expression
    EnablePolicy bool
    Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled
    Id string
    Uniquely identifies the resource.
    Name string
    Policy Name
    PlanNumber int
    Number of backup plans associated with this policy
    PolicyId string
    Backup Policy ID
    RetentionDay int
    Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]
    RetentionNumMax int
    Maximum number of restore points retained
    RetentionNumMin int
    Minimum restore point retention limit
    UpdatedTime string
    Update time
    accountId String
    Account ID that created this policy
    backupType String
    Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup
    createdTime String
    Creation time
    crontab String
    Backup cycle, using a crontab expression
    enablePolicy Boolean
    Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled
    id String
    Uniquely identifies the resource.
    name String
    Policy Name
    planNumber Integer
    Number of backup plans associated with this policy
    policyId String
    Backup Policy ID
    retentionDay Integer
    Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]
    retentionNumMax Integer
    Maximum number of restore points retained
    retentionNumMin Integer
    Minimum restore point retention limit
    updatedTime String
    Update time
    accountId string
    Account ID that created this policy
    backupType string
    Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup
    createdTime string
    Creation time
    crontab string
    Backup cycle, using a crontab expression
    enablePolicy boolean
    Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled
    id string
    Uniquely identifies the resource.
    name string
    Policy Name
    planNumber number
    Number of backup plans associated with this policy
    policyId string
    Backup Policy ID
    retentionDay number
    Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]
    retentionNumMax number
    Maximum number of restore points retained
    retentionNumMin number
    Minimum restore point retention limit
    updatedTime string
    Update time
    account_id str
    Account ID that created this policy
    backup_type str
    Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup
    created_time str
    Creation time
    crontab str
    Backup cycle, using a crontab expression
    enable_policy bool
    Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled
    id str
    Uniquely identifies the resource.
    name str
    Policy Name
    plan_number int
    Number of backup plans associated with this policy
    policy_id str
    Backup Policy ID
    retention_day int
    Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]
    retention_num_max int
    Maximum number of restore points retained
    retention_num_min int
    Minimum restore point retention limit
    updated_time str
    Update time
    accountId String
    Account ID that created this policy
    backupType String
    Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup
    createdTime String
    Creation time
    crontab String
    Backup cycle, using a crontab expression
    enablePolicy Boolean
    Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled
    id String
    Uniquely identifies the resource.
    name String
    Policy Name
    planNumber Number
    Number of backup plans associated with this policy
    policyId String
    Backup Policy ID
    retentionDay Number
    Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]
    retentionNumMax Number
    Maximum number of restore points retained
    retentionNumMin Number
    Minimum restore point retention limit
    updatedTime String
    Update time

    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.