Skip to content

DownloadProps

Properties for defining a Download.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkdbs"
&alicloudroscdkdbs.DownloadProps {
    FormatType: interface{},
    InstanceName: interface{},
    BakSetId: interface{},
    BakSetSize: interface{},
    BakSetType: interface{},
    DeleteBackupSetInOss: interface{},
    DownloadAddressDuration: interface{},
    DownloadPointInTime: interface{},
    TargetBucket: interface{},
    TargetOssRegion: interface{},
    TargetPath: interface{},
    TargetType: interface{},
}

Properties

Name Type Description
FormatType interface{} Property formatType: The format to which the downloaded backup set is converted.
InstanceName interface{} Property instanceName: The ID of the instance.
BakSetId interface{} Property bakSetId: The ID of the backup set.
BakSetSize interface{} Property bakSetSize: The size of the full backup set.
BakSetType interface{} Property bakSetType: The type of the download task.
DeleteBackupSetInOss interface{} Property deleteBackupSetInOss: Whether to delete the backup set in OSS when deleting the stack.
DownloadAddressDuration interface{} Property downloadAddressDuration: When the download target is a URL, set the link validity period.
DownloadPointInTime interface{} Property downloadPointInTime: The point in time at which the backup set is downloaded.
TargetBucket interface{} Property targetBucket: The name of the OSS bucket that is used to store the backup set.
TargetOssRegion interface{} Property targetOssRegion: The region in which the OSS bucket resides.
TargetPath interface{} Property targetPath: The destination path to which the backup set is downloaded.
TargetType interface{} Property targetType: The type of the destination to which the backup set is downloaded.

FormatTypeRequired

FormatType interface{}
  • Type: interface{}

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

Valid values: CSV|SQL|Parquet


InstanceNameRequired

InstanceName interface{}
  • Type: interface{}

Property instanceName: The ID of the instance.


BakSetIdOptional

BakSetId interface{}
  • Type: interface{}

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

BakSetSize interface{}
  • Type: interface{}

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

BakSetType interface{}
  • Type: interface{}

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

DeleteBackupSetInOss interface{}
  • Type: interface{}

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

Valid values: true|false, default is true.


DownloadAddressDurationOptional

DownloadAddressDuration interface{}
  • Type: interface{}

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

DownloadPointInTime interface{}
  • Type: interface{}

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

TargetBucket interface{}
  • Type: interface{}

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

TargetOssRegion interface{}
  • Type: interface{}

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

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


TargetPathOptional

TargetPath interface{}
  • Type: interface{}

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

TargetType interface{}
  • Type: interface{}

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

Valid values: OSS|URL