Skip to content

DownloadProps

Properties for defining a Download.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dbs-download

Initializer 

import ros_cdk_dbs
ros_cdk_dbs.DownloadProps(
  format_type: typing.Union[str, IResolvable],
  instance_name: typing.Union[str, IResolvable],
  bak_set_id: typing.Union[str, IResolvable] = None,
  bak_set_size: typing.Union[str, IResolvable] = None,
  bak_set_type: typing.Union[str, IResolvable] = None,
  delete_backup_set_in_oss: typing.Union[bool, IResolvable] = None,
  download_address_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  download_point_in_time: typing.Union[str, IResolvable] = None,
  target_bucket: typing.Union[str, IResolvable] = None,
  target_oss_region: typing.Union[str, IResolvable] = None,
  target_path: typing.Union[str, IResolvable] = None,
  target_type: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
format_type typing.Union[str, ros_cdk_core.IResolvable] Property formatType: The format to which the downloaded backup set is converted.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The ID of the instance.
bak_set_id typing.Union[str, ros_cdk_core.IResolvable] Property bakSetId: The ID of the backup set.
bak_set_size typing.Union[str, ros_cdk_core.IResolvable] Property bakSetSize: The size of the full backup set.
bak_set_type typing.Union[str, ros_cdk_core.IResolvable] Property bakSetType: The type of the download task.
delete_backup_set_in_oss typing.Union[bool, ros_cdk_core.IResolvable] Property deleteBackupSetInOss: Whether to delete the backup set in OSS when deleting the stack.
download_address_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property downloadAddressDuration: When the download target is a URL, set the link validity period.
download_point_in_time typing.Union[str, ros_cdk_core.IResolvable] Property downloadPointInTime: The point in time at which the backup set is downloaded.
target_bucket typing.Union[str, ros_cdk_core.IResolvable] Property targetBucket: The name of the OSS bucket that is used to store the backup set.
target_oss_region typing.Union[str, ros_cdk_core.IResolvable] Property targetOssRegion: The region in which the OSS bucket resides.
target_path typing.Union[str, ros_cdk_core.IResolvable] Property targetPath: The destination path to which the backup set is downloaded.
target_type typing.Union[str, ros_cdk_core.IResolvable] Property targetType: The type of the destination to which the backup set is downloaded.

format_typeRequired 

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

Property formatType: The format to which the downloaded backup set is converted.

Valid values: CSV|SQL|Parquet

instance_nameRequired 

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

Property instanceName: The ID of the instance.

bak_set_idOptional 

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

Property bakSetId: The ID of the backup set.

You can call the DescribeBackups operation to query the ID of the backup set. This parameter is required if the BakSetType parameter is set to full.

bak_set_sizeOptional 

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

Property bakSetSize: The size of the full backup set.

Unit: bytes. You can call the DescribeBackups operation to query the size of the full backup set.

bak_set_typeOptional 

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

Property bakSetType: The type of the download task.

Valid values: full: downloads a full backup set pitr: downloads a backup set at a specific point in time.

delete_backup_set_in_ossOptional 

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

Property deleteBackupSetInOss: Whether to delete the backup set in OSS when deleting the stack.

Valid values: true|false, default is true.

download_address_durationOptional 

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

Property downloadAddressDuration: When the download target is a URL, set the link validity period.

The default URL validity period is 7200 seconds. The effective duration range can be set from 300 seconds to 86400 seconds

download_point_in_timeOptional 

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

Property downloadPointInTime: The point in time at which the backup set is downloaded.

Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. This parameter is required if the BakSetType parameter is set to pitr.

target_bucketOptional 

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

Property targetBucket: The name of the OSS bucket that is used to store the backup set.

This parameter is required if the TargetType parameter is set to OSS. Make sure that your account is granted the AliyunDBSDefaultRole permission. For more information, see Use RAM for resource authorization. You can also grant permissions based on the operation instructions in the Resource Access Management (RAM) console.

target_oss_regionOptional 

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

Property targetOssRegion: The region in which the OSS bucket resides.

This parameter is required if the TargetType parameter is set to OSS.

target_pathOptional 

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

Property targetPath: The destination path to which the backup set is downloaded.

This parameter is required if the TargetType parameter is set to OSS.

target_typeOptional 

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

Property targetType: The type of the destination to which the backup set is downloaded.

Valid values: OSS|URL