Skip to content

OssBackupPlanProps

Properties for defining a OssBackupPlan.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-ossbackupplan

Initializer

import com.aliyun.ros.cdk.hbr.OssBackupPlanProps;
OssBackupPlanProps.builder()
    .backupType(java.lang.String)
    .backupType(IResolvable)
    .bucket(java.lang.String)
    .bucket(IResolvable)
    .planName(java.lang.String)
    .planName(IResolvable)
    .retention(java.lang.Number)
    .retention(IResolvable)
    .schedule(java.lang.String)
    .schedule(IResolvable)
    .vaultId(java.lang.String)
    .vaultId(IResolvable)
//  .crossAccountRoleName(java.lang.String)
//  .crossAccountRoleName(IResolvable)
//  .crossAccountType(java.lang.String)
//  .crossAccountType(IResolvable)
//  .crossAccountUserId(java.lang.String)
//  .crossAccountUserId(IResolvable)
//  .disabled(java.lang.Boolean)
//  .disabled(IResolvable)
//  .prefix(java.lang.String)
//  .prefix(IResolvable)
    .build();

Properties

Name Type Description
backupType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupType: Backup type.
bucket java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bucket: The name of OSS bucket.
planName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property planName: The name of the backup plan.
retention java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property retention: Backup retention days, the minimum is 1.
schedule java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property schedule: The backup policy.
vaultId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vaultId: The ID of backup vault.
crossAccountRoleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property crossAccountRoleName: The role name created in the original account RAM backup by the cross account managed by the current account.
crossAccountType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property crossAccountType: The type of the cross account backup.
crossAccountUserId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property crossAccountUserId: The original account ID of the cross account backup managed by the current account.
disabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property disabled: Whether to disable the backup task.
prefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property prefix: Backup prefix.

backupTypeRequired

public java.lang.Object getBackupType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property backupType: Backup type.

Valid values: COMPLETE.


bucketRequired

public java.lang.Object getBucket();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property bucket: The name of OSS bucket.


planNameRequired

public java.lang.Object getPlanName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property planName: 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.


retentionRequired

public java.lang.Object getRetention();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property retention: Backup retention days, the minimum is 1.


scheduleRequired

public java.lang.Object getSchedule();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property schedule: The backup policy.

The format is I|{startTime}|{interval}. This specifies that a backup job runs at an interval of {interval}, starting from {startTime}. Overdue backup jobs are not retried. If the previous backup job is not complete, the next backup job is not triggered. For example, I|1631685600|P1D indicates that a backup job runs daily starting from 14:00:00 on September 15, 2021.

  • startTime: The start time for the backup, specified as a UNIX timestamp in seconds.
  • interval: The backup interval, specified in the ISO 8601 duration format. For example, PT1H represents one hour and P1D represents one day.

vaultIdRequired

public java.lang.Object getVaultId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vaultId: The ID of backup vault.


crossAccountRoleNameOptional

public java.lang.Object getCrossAccountRoleName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property crossAccountRoleName: The role name created in the original account RAM backup by the cross account managed by the current account.


crossAccountTypeOptional

public java.lang.Object getCrossAccountType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property crossAccountType: The type of the cross account backup.

Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.


crossAccountUserIdOptional

public java.lang.Object getCrossAccountUserId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property crossAccountUserId: The original account ID of the cross account backup managed by the current account.


disabledOptional

public java.lang.Object getDisabled();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property disabled: Whether to disable the backup task.

Valid values: true, false.


prefixOptional

public java.lang.Object getPrefix();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property prefix: Backup prefix.

Once specified, only objects with matching prefixes will be backed up.