Skip to content

EcsBackupPlanProps

Properties for defining a EcsBackupPlan.

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

Initializer

import com.aliyun.ros.cdk.hbr.EcsBackupPlanProps;
EcsBackupPlanProps.builder()
    .backupType(java.lang.String)
    .backupType(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(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)
//  .detail(IResolvable)
//  .detail(java.util.Map<java.lang.String, java.lang.Object>)
//  .disabled(java.lang.Boolean)
//  .disabled(IResolvable)
//  .exclude(java.lang.String)
//  .exclude(IResolvable)
//  .include(java.lang.String)
//  .include(IResolvable)
//  .options(IResolvable)
//  .options(java.util.Map<java.lang.String, java.lang.Object>)
//  .paths(IResolvable)
//  .paths(java.util.List<java.lang.String)
//  .paths(IResolvable>)
//  .speedLimit(java.lang.String)
//  .speedLimit(IResolvable)
    .build();

Properties

Name Type Description
backupType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupType: Backup type.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of ECS instance.
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.
detail com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property detail: The detail of the backup plan.
disabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property disabled: Whether to disable the backup task.
exclude java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property exclude: The exclude paths of the backup plan.
include java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property include: The include paths of the backup plan.
options com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property options: Windows operating system with application consistency using VSS, e.g: {"UseVSS":false}.
paths com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property paths: The paths of the backup plan.
speedLimit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property speedLimit: The speed limit of the backup plan.

backupTypeRequired

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

Property backupType: Backup type.

Valid values: COMPLETE.


instanceIdRequired

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

Property instanceId: The ID of ECS instance.

The ecs backup client must have been installed on the host.


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.


detailOptional

public java.lang.Object getDetail();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property detail: The detail of the backup plan.


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.


excludeOptional

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

Property exclude: The exclude paths of the backup plan.


includeOptional

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

Property include: The include paths of the backup plan.


optionsOptional

public java.lang.Object getOptions();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property options: Windows operating system with application consistency using VSS, e.g: {"UseVSS":false}.


pathsOptional

public java.lang.Object getPaths();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property paths: The paths of the backup plan.


speedLimitOptional

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

Property speedLimit: The speed limit of the backup plan.