Skip to content

OssBackupPlanProps

Properties for defining a OssBackupPlan.

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

Initializer

import ros_cdk_hbr
ros_cdk_hbr.OssBackupPlanProps(
  backup_type: typing.Union[str, IResolvable],
  bucket: 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,
  disabled: typing.Union[bool, IResolvable] = None,
  prefix: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
backup_type typing.Union[str, ros_cdk_core.IResolvable] Property backupType: Backup type.
bucket typing.Union[str, ros_cdk_core.IResolvable] Property bucket: The name of OSS bucket.
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.
disabled typing.Union[bool, ros_cdk_core.IResolvable] Property disabled: Whether to disable the backup task.
prefix typing.Union[str, ros_cdk_core.IResolvable] Property prefix: Backup prefix.

backup_typeRequired

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

Property backupType: Backup type.

Valid values: COMPLETE.


bucketRequired

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

Property bucket: The name of OSS bucket.


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.


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.


prefixOptional

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

Property prefix: Backup prefix.

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