Skip to content

EcsBackupPlanProps

Properties for defining a EcsBackupPlan.

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

Initializer

import ros_cdk_hbr
ros_cdk_hbr.EcsBackupPlanProps(
  backup_type: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  plan_name: typing.Union[str, IResolvable],
  retention: typing.Union[typing.Union[int, float], IResolvable],
  schedule: typing.Union[str, IResolvable],
  vault_id: typing.Union[str, IResolvable],
  cross_account_role_name: typing.Union[str, IResolvable] = None,
  cross_account_type: typing.Union[str, IResolvable] = None,
  cross_account_user_id: typing.Union[str, IResolvable] = None,
  detail: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  disabled: typing.Union[bool, IResolvable] = None,
  exclude: typing.Union[str, IResolvable] = None,
  include: typing.Union[str, IResolvable] = None,
  options: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  paths: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  speed_limit: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
backup_type typing.Union[str, ros_cdk_core.IResolvable] Property backupType: Backup type.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of ECS instance.
plan_name typing.Union[str, ros_cdk_core.IResolvable] Property planName: The name of the backup plan.
retention typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property retention: Backup retention days, the minimum is 1.
schedule typing.Union[str, ros_cdk_core.IResolvable] Property schedule: The backup policy.
vault_id typing.Union[str, ros_cdk_core.IResolvable] Property vaultId: The ID of backup vault.
cross_account_role_name typing.Union[str, 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.
cross_account_type typing.Union[str, ros_cdk_core.IResolvable] Property crossAccountType: The type of the cross account backup.
cross_account_user_id typing.Union[str, ros_cdk_core.IResolvable] Property crossAccountUserId: The original account ID of the cross account backup managed by the current account.
detail typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property detail: The detail of the backup plan.
disabled typing.Union[bool, ros_cdk_core.IResolvable] Property disabled: Whether to disable the backup task.
exclude typing.Union[str, ros_cdk_core.IResolvable] Property exclude: The exclude paths of the backup plan.
include typing.Union[str, ros_cdk_core.IResolvable] Property include: The include paths of the backup plan.
options typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property options: Windows operating system with application consistency using VSS, e.g: {"UseVSS":false}.
paths typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property paths: The paths of the backup plan.
speed_limit typing.Union[str, ros_cdk_core.IResolvable] Property speedLimit: The speed limit of the backup plan.

backup_typeRequired

backup_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property backupType: Backup type.

Valid values: COMPLETE.


instance_idRequired

instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The ID of ECS instance.

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


plan_nameRequired

plan_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

retention: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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


scheduleRequired

schedule: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

vault_idRequired

vault_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vaultId: The ID of backup vault.


cross_account_role_nameOptional

cross_account_role_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


cross_account_typeOptional

cross_account_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property crossAccountType: The type of the cross account backup.

Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.


cross_account_user_idOptional

cross_account_user_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


detailOptional

detail: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property detail: The detail of the backup plan.


disabledOptional

disabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property disabled: Whether to disable the backup task.

Valid values: true, false.


excludeOptional

exclude: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property exclude: The exclude paths of the backup plan.


includeOptional

include: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property include: The include paths of the backup plan.


optionsOptional

options: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

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


pathsOptional

paths: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property paths: The paths of the backup plan.


speed_limitOptional

speed_limit: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property speedLimit: The speed limit of the backup plan.