Skip to content

DownloadProps

Properties for defining a Download.

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

Initializer 

import { DownloadProps } from '@alicloud/ros-cdk-dbs'
const downloadProps: DownloadProps = { ... }

Properties

Name Type Description
formatType string | @alicloud/ros-cdk-core.IResolvable Property formatType: The format to which the downloaded backup set is converted.
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: The ID of the instance.
bakSetId string | @alicloud/ros-cdk-core.IResolvable Property bakSetId: The ID of the backup set.
bakSetSize string | @alicloud/ros-cdk-core.IResolvable Property bakSetSize: The size of the full backup set.
bakSetType string | @alicloud/ros-cdk-core.IResolvable Property bakSetType: The type of the download task.
deleteBackupSetInOss boolean | @alicloud/ros-cdk-core.IResolvable Property deleteBackupSetInOss: Whether to delete the backup set in OSS when deleting the stack.
downloadAddressDuration number | @alicloud/ros-cdk-core.IResolvable Property downloadAddressDuration: When the download target is a URL, set the link validity period.
downloadPointInTime string | @alicloud/ros-cdk-core.IResolvable Property downloadPointInTime: The point in time at which the backup set is downloaded.
targetBucket string | @alicloud/ros-cdk-core.IResolvable Property targetBucket: The name of the OSS bucket that is used to store the backup set.
targetOssRegion string | @alicloud/ros-cdk-core.IResolvable Property targetOssRegion: The region in which the OSS bucket resides.
targetPath string | @alicloud/ros-cdk-core.IResolvable Property targetPath: The destination path to which the backup set is downloaded.
targetType string | @alicloud/ros-cdk-core.IResolvable Property targetType: The type of the destination to which the backup set is downloaded.

formatTypeRequired 

public readonly formatType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Valid values: CSV|SQL|Parquet

instanceNameRequired 

public readonly instanceName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceName: The ID of the instance.

bakSetIdOptional 

public readonly bakSetId: string | IResolvable;
  • Type: string | @alicloud/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.

bakSetSizeOptional 

public readonly bakSetSize: string | IResolvable;
  • Type: string | @alicloud/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.

bakSetTypeOptional 

public readonly bakSetType: string | IResolvable;
  • Type: string | @alicloud/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.

deleteBackupSetInOssOptional 

public readonly deleteBackupSetInOss: boolean | IResolvable;
  • Type: boolean | @alicloud/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.

downloadAddressDurationOptional 

public readonly downloadAddressDuration: number | IResolvable;
  • Type: number | @alicloud/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

downloadPointInTimeOptional 

public readonly downloadPointInTime: string | IResolvable;
  • Type: string | @alicloud/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.

targetBucketOptional 

public readonly targetBucket: string | IResolvable;
  • Type: string | @alicloud/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.

targetOssRegionOptional 

public readonly targetOssRegion: string | IResolvable;
  • Type: string | @alicloud/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.

targetPathOptional 

public readonly targetPath: string | IResolvable;
  • Type: string | @alicloud/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.

targetTypeOptional 

public readonly targetType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Valid values: OSS|URL