Skip to content

DownloadProps

Properties for defining a Download.

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

Initializer 

import com.aliyun.ros.cdk.dbs.DownloadProps;
DownloadProps.builder()
    .formatType(java.lang.String)
    .formatType(IResolvable)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
//  .bakSetId(java.lang.String)
//  .bakSetId(IResolvable)
//  .bakSetSize(java.lang.String)
//  .bakSetSize(IResolvable)
//  .bakSetType(java.lang.String)
//  .bakSetType(IResolvable)
//  .deleteBackupSetInOss(java.lang.Boolean)
//  .deleteBackupSetInOss(IResolvable)
//  .downloadAddressDuration(java.lang.Number)
//  .downloadAddressDuration(IResolvable)
//  .downloadPointInTime(java.lang.String)
//  .downloadPointInTime(IResolvable)
//  .targetBucket(java.lang.String)
//  .targetBucket(IResolvable)
//  .targetOssRegion(java.lang.String)
//  .targetOssRegion(IResolvable)
//  .targetPath(java.lang.String)
//  .targetPath(IResolvable)
//  .targetType(java.lang.String)
//  .targetType(IResolvable)
    .build();

Properties

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

formatTypeRequired 

public java.lang.Object getFormatType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: CSV|SQL|Parquet

instanceNameRequired 

public java.lang.Object getInstanceName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceName: The ID of the instance.

bakSetIdOptional 

public java.lang.Object getBakSetId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getBakSetSize();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getBakSetType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDeleteBackupSetInOss();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getDownloadAddressDuration();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDownloadPointInTime();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getTargetBucket();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getTargetOssRegion();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getTargetPath();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getTargetType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: OSS|URL