Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. hbr
  5. OssBackupPlan
Alibaba Cloud v3.81.0 published on Monday, Jun 23, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.hbr.OssBackupPlan

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.81.0 published on Monday, Jun 23, 2025 by Pulumi
pulumi/pulumi-alicloud

    Provides a HBR Oss Backup Plan resource.

    For information about HBR Oss Backup Plan and how to use it, see What is Oss Backup Plan.

    NOTE: Available since v1.131.0.

    NOTE: Deprecated since v1.249.0.

    DEPRECATED: This resource has been deprecated from version 1.249.0. Please use new resource alicloud.hbr.Policy and alicloud_hbr_policy_binding.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
import * as random from "@pulumi/random";

const _default = new random.index.Integer("default", {
    max: 99999,
    min: 10000,
});
const defaultVault = new alicloud.hbr.Vault("default", {vaultName: `terraform-example-${_default.result}`});
const defaultBucket = new alicloud.oss.Bucket("default", {bucket: `terraform-example-${_default.result}`});
const defaultOssBackupPlan = new alicloud.hbr.OssBackupPlan("default", {
    ossBackupPlanName: "terraform-example",
    prefix: "/example",
    bucket: defaultBucket.bucket,
    vaultId: defaultVault.id,
    schedule: "I|1602673264|PT2H",
    backupType: "COMPLETE",
    retention: "2",
});

    import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random

default = random.index.Integer("default",
    max=99999,
    min=10000)
default_vault = alicloud.hbr.Vault("default", vault_name=f"terraform-example-{default['result']}")
default_bucket = alicloud.oss.Bucket("default", bucket=f"terraform-example-{default['result']}")
default_oss_backup_plan = alicloud.hbr.OssBackupPlan("default",
    oss_backup_plan_name="terraform-example",
    prefix="/example",
    bucket=default_bucket.bucket,
    vault_id=default_vault.id,
    schedule="I|1602673264|PT2H",
    backup_type="COMPLETE",
    retention="2")

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/oss"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
			Max: 99999,
			Min: 10000,
		})
		if err != nil {
			return err
		}
		defaultVault, err := hbr.NewVault(ctx, "default", &hbr.VaultArgs{
			VaultName: pulumi.Sprintf("terraform-example-%v", _default.Result),
		})
		if err != nil {
			return err
		}
		defaultBucket, err := oss.NewBucket(ctx, "default", &oss.BucketArgs{
			Bucket: pulumi.Sprintf("terraform-example-%v", _default.Result),
		})
		if err != nil {
			return err
		}
		_, err = hbr.NewOssBackupPlan(ctx, "default", &hbr.OssBackupPlanArgs{
			OssBackupPlanName: pulumi.String("terraform-example"),
			Prefix:            pulumi.String("/example"),
			Bucket:            defaultBucket.Bucket,
			VaultId:           defaultVault.ID(),
			Schedule:          pulumi.String("I|1602673264|PT2H"),
			BackupType:        pulumi.String("COMPLETE"),
			Retention:         pulumi.String("2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var @default = new Random.Index.Integer("default", new()
    {
        Max = 99999,
        Min = 10000,
    });

    var defaultVault = new AliCloud.Hbr.Vault("default", new()
    {
        VaultName = $"terraform-example-{@default.Result}",
    });

    var defaultBucket = new AliCloud.Oss.Bucket("default", new()
    {
        BucketName = $"terraform-example-{@default.Result}",
    });

    var defaultOssBackupPlan = new AliCloud.Hbr.OssBackupPlan("default", new()
    {
        OssBackupPlanName = "terraform-example",
        Prefix = "/example",
        Bucket = defaultBucket.BucketName,
        VaultId = defaultVault.Id,
        Schedule = "I|1602673264|PT2H",
        BackupType = "COMPLETE",
        Retention = "2",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.integer;
import com.pulumi.random.integerArgs;
import com.pulumi.alicloud.hbr.Vault;
import com.pulumi.alicloud.hbr.VaultArgs;
import com.pulumi.alicloud.oss.Bucket;
import com.pulumi.alicloud.oss.BucketArgs;
import com.pulumi.alicloud.hbr.OssBackupPlan;
import com.pulumi.alicloud.hbr.OssBackupPlanArgs;
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 default_ = new Integer("default", IntegerArgs.builder()
            .max(99999)
            .min(10000)
            .build());

        var defaultVault = new Vault("defaultVault", VaultArgs.builder()
            .vaultName(String.format("terraform-example-%s", default_.result()))
            .build());

        var defaultBucket = new Bucket("defaultBucket", BucketArgs.builder()
            .bucket(String.format("terraform-example-%s", default_.result()))
            .build());

        var defaultOssBackupPlan = new OssBackupPlan("defaultOssBackupPlan", OssBackupPlanArgs.builder()
            .ossBackupPlanName("terraform-example")
            .prefix("/example")
            .bucket(defaultBucket.bucket())
            .vaultId(defaultVault.id())
            .schedule("I|1602673264|PT2H")
            .backupType("COMPLETE")
            .retention("2")
            .build());

    }
}

    resources:
  default:
    type: random:integer
    properties:
      max: 99999
      min: 10000
  defaultVault:
    type: alicloud:hbr:Vault
    name: default
    properties:
      vaultName: terraform-example-${default.result}
  defaultBucket:
    type: alicloud:oss:Bucket
    name: default
    properties:
      bucket: terraform-example-${default.result}
  defaultOssBackupPlan:
    type: alicloud:hbr:OssBackupPlan
    name: default
    properties:
      ossBackupPlanName: terraform-example
      prefix: /example
      bucket: ${defaultBucket.bucket}
      vaultId: ${defaultVault.id}
      schedule: I|1602673264|PT2H
      backupType: COMPLETE
      retention: '2'

    Create OssBackupPlan Resource

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

    Constructor syntax

    new OssBackupPlan(name: string, args: OssBackupPlanArgs, opts?: CustomResourceOptions);
    @overload
def OssBackupPlan(resource_name: str,
                  args: OssBackupPlanArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def OssBackupPlan(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  backup_type: Optional[str] = None,
                  bucket: Optional[str] = None,
                  oss_backup_plan_name: Optional[str] = None,
                  retention: Optional[str] = None,
                  schedule: Optional[str] = None,
                  vault_id: Optional[str] = None,
                  cross_account_role_name: Optional[str] = None,
                  cross_account_type: Optional[str] = None,
                  cross_account_user_id: Optional[int] = None,
                  disabled: Optional[bool] = None,
                  prefix: Optional[str] = None)
    func NewOssBackupPlan(ctx *Context, name string, args OssBackupPlanArgs, opts ...ResourceOption) (*OssBackupPlan, error)
    public OssBackupPlan(string name, OssBackupPlanArgs args, CustomResourceOptions? opts = null)
    public OssBackupPlan(String name, OssBackupPlanArgs args)
public OssBackupPlan(String name, OssBackupPlanArgs args, CustomResourceOptions options)

    type: alicloud:hbr:OssBackupPlan
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 OssBackupPlanArgs
    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 OssBackupPlanArgs
    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 OssBackupPlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OssBackupPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OssBackupPlanArgs
    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 ossBackupPlanResource = new AliCloud.Hbr.OssBackupPlan("ossBackupPlanResource", new()
{
    BackupType = "string",
    Bucket = "string",
    OssBackupPlanName = "string",
    Retention = "string",
    Schedule = "string",
    VaultId = "string",
    CrossAccountRoleName = "string",
    CrossAccountType = "string",
    CrossAccountUserId = 0,
    Disabled = false,
    Prefix = "string",
});

    example, err := hbr.NewOssBackupPlan(ctx, "ossBackupPlanResource", &hbr.OssBackupPlanArgs{
	BackupType:           pulumi.String("string"),
	Bucket:               pulumi.String("string"),
	OssBackupPlanName:    pulumi.String("string"),
	Retention:            pulumi.String("string"),
	Schedule:             pulumi.String("string"),
	VaultId:              pulumi.String("string"),
	CrossAccountRoleName: pulumi.String("string"),
	CrossAccountType:     pulumi.String("string"),
	CrossAccountUserId:   pulumi.Int(0),
	Disabled:             pulumi.Bool(false),
	Prefix:               pulumi.String("string"),
})

    var ossBackupPlanResource = new OssBackupPlan("ossBackupPlanResource", OssBackupPlanArgs.builder()
    .backupType("string")
    .bucket("string")
    .ossBackupPlanName("string")
    .retention("string")
    .schedule("string")
    .vaultId("string")
    .crossAccountRoleName("string")
    .crossAccountType("string")
    .crossAccountUserId(0)
    .disabled(false)
    .prefix("string")
    .build());

    oss_backup_plan_resource = alicloud.hbr.OssBackupPlan("ossBackupPlanResource",
    backup_type="string",
    bucket="string",
    oss_backup_plan_name="string",
    retention="string",
    schedule="string",
    vault_id="string",
    cross_account_role_name="string",
    cross_account_type="string",
    cross_account_user_id=0,
    disabled=False,
    prefix="string")

    const ossBackupPlanResource = new alicloud.hbr.OssBackupPlan("ossBackupPlanResource", {
    backupType: "string",
    bucket: "string",
    ossBackupPlanName: "string",
    retention: "string",
    schedule: "string",
    vaultId: "string",
    crossAccountRoleName: "string",
    crossAccountType: "string",
    crossAccountUserId: 0,
    disabled: false,
    prefix: "string",
});

    type: alicloud:hbr:OssBackupPlan
properties:
    backupType: string
    bucket: string
    crossAccountRoleName: string
    crossAccountType: string
    crossAccountUserId: 0
    disabled: false
    ossBackupPlanName: string
    prefix: string
    retention: string
    schedule: string
    vaultId: string

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

    BackupType string
    Backup type. Valid values: COMPLETE.
    Bucket string
    The name of OSS bucket.
    OssBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    VaultId string
    The ID of backup vault.
    CrossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    CrossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    CrossAccountUserId int
    The original account ID of the cross account backup managed by the current account.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    Prefix string
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    BackupType string
    Backup type. Valid values: COMPLETE.
    Bucket string
    The name of OSS bucket.
    OssBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    VaultId string
    The ID of backup vault.
    CrossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    CrossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    CrossAccountUserId int
    The original account ID of the cross account backup managed by the current account.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    Prefix string
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    backupType String
    Backup type. Valid values: COMPLETE.
    bucket String
    The name of OSS bucket.
    ossBackupPlanName String
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vaultId String
    The ID of backup vault.
    crossAccountRoleName String
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType String
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId Integer
    The original account ID of the cross account backup managed by the current account.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    prefix String
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    backupType string
    Backup type. Valid values: COMPLETE.
    bucket string
    The name of OSS bucket.
    ossBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    retention string
    Backup retention days, the minimum is 1.
    schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vaultId string
    The ID of backup vault.
    crossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId number
    The original account ID of the cross account backup managed by the current account.
    disabled boolean
    Whether to disable the backup task. Valid values: true, false.
    prefix string
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    backup_type str
    Backup type. Valid values: COMPLETE.
    bucket str
    The name of OSS bucket.
    oss_backup_plan_name str
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    retention str
    Backup retention days, the minimum is 1.
    schedule str
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vault_id str
    The ID of backup vault.
    cross_account_role_name str
    The role name created in the original account RAM backup by the cross account managed by the current account.
    cross_account_type str
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    cross_account_user_id int
    The original account ID of the cross account backup managed by the current account.
    disabled bool
    Whether to disable the backup task. Valid values: true, false.
    prefix str
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    backupType String
    Backup type. Valid values: COMPLETE.
    bucket String
    The name of OSS bucket.
    ossBackupPlanName String
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vaultId String
    The ID of backup vault.
    crossAccountRoleName String
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType String
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId Number
    The original account ID of the cross account backup managed by the current account.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    prefix String
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OssBackupPlan Resource

    Get an existing OssBackupPlan 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?: OssBackupPlanState, opts?: CustomResourceOptions): OssBackupPlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_type: Optional[str] = None,
        bucket: Optional[str] = None,
        cross_account_role_name: Optional[str] = None,
        cross_account_type: Optional[str] = None,
        cross_account_user_id: Optional[int] = None,
        disabled: Optional[bool] = None,
        oss_backup_plan_name: Optional[str] = None,
        prefix: Optional[str] = None,
        retention: Optional[str] = None,
        schedule: Optional[str] = None,
        vault_id: Optional[str] = None) -> OssBackupPlan
    func GetOssBackupPlan(ctx *Context, name string, id IDInput, state *OssBackupPlanState, opts ...ResourceOption) (*OssBackupPlan, error)
    public static OssBackupPlan Get(string name, Input<string> id, OssBackupPlanState? state, CustomResourceOptions? opts = null)
    public static OssBackupPlan get(String name, Output<String> id, OssBackupPlanState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:hbr:OssBackupPlan    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:
    BackupType string
    Backup type. Valid values: COMPLETE.
    Bucket string
    The name of OSS bucket.
    CrossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    CrossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    CrossAccountUserId int
    The original account ID of the cross account backup managed by the current account.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    OssBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    Prefix string
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    VaultId string
    The ID of backup vault.
    BackupType string
    Backup type. Valid values: COMPLETE.
    Bucket string
    The name of OSS bucket.
    CrossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    CrossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    CrossAccountUserId int
    The original account ID of the cross account backup managed by the current account.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    OssBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    Prefix string
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    VaultId string
    The ID of backup vault.
    backupType String
    Backup type. Valid values: COMPLETE.
    bucket String
    The name of OSS bucket.
    crossAccountRoleName String
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType String
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId Integer
    The original account ID of the cross account backup managed by the current account.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    ossBackupPlanName String
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    prefix String
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vaultId String
    The ID of backup vault.
    backupType string
    Backup type. Valid values: COMPLETE.
    bucket string
    The name of OSS bucket.
    crossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId number
    The original account ID of the cross account backup managed by the current account.
    disabled boolean
    Whether to disable the backup task. Valid values: true, false.
    ossBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    prefix string
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    retention string
    Backup retention days, the minimum is 1.
    schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vaultId string
    The ID of backup vault.
    backup_type str
    Backup type. Valid values: COMPLETE.
    bucket str
    The name of OSS bucket.
    cross_account_role_name str
    The role name created in the original account RAM backup by the cross account managed by the current account.
    cross_account_type str
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    cross_account_user_id int
    The original account ID of the cross account backup managed by the current account.
    disabled bool
    Whether to disable the backup task. Valid values: true, false.
    oss_backup_plan_name str
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    prefix str
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    retention str
    Backup retention days, the minimum is 1.
    schedule str
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vault_id str
    The ID of backup vault.
    backupType String
    Backup type. Valid values: COMPLETE.
    bucket String
    The name of OSS bucket.
    crossAccountRoleName String
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType String
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId Number
    The original account ID of the cross account backup managed by the current account.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    ossBackupPlanName String
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    prefix String
    Backup prefix. Once specified, only objects with matching prefixes will be backed up.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vaultId String
    The ID of backup vault.

    Import

    HBR Oss Backup Plan can be imported using the id, e.g.

    $ pulumi import alicloud:hbr/ossBackupPlan:OssBackupPlan example <id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.81.0 published on Monday, Jun 23, 2025 by Pulumi
    pulumi/pulumi-alicloud