Download

This class encapsulates and extends the ROS resource type ALIYUN::DBS::Download, which is used to create an advanced download task.

Initializers

import com.aliyun.ros.cdk.dbs.Download;
Download.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No 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.

`scope`^Required

Type: com.aliyun.ros.cdk.core.Construct

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`formatType`^Required

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

`instanceName`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceName: The ID of the instance.

`bakSetId`^Optional

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.

`bakSetSize`^Optional

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.

`bakSetType`^Optional

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.

`deleteBackupSetInOss`^Optional

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.

`downloadAddressDuration`^Optional

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

`downloadPointInTime`^Optional

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.

`targetBucket`^Optional

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.

`targetOssRegion`^Optional

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.

`targetPath`^Optional

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.

`targetType`^Optional

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

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`addCondition`	No description.
`addCount`	No description.
`addDependency`	No description.
`addResourceDesc`	No description.
`applyRemovalPolicy`	No description.
`getAtt`	No description.
`setMetadata`	No description.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`synthesize`

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

Type: com.aliyun.ros.cdk.core.RosCondition

`addCount`

public void addCount(java.lang.Number OR IResolvable count)

count^Required

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

Type: com.aliyun.ros.cdk.core.RemovalPolicy

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`isConstruct`

import com.aliyun.ros.cdk.dbs.Download;
Download.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`java.lang.String`	No description.
`stack`	`com.aliyun.ros.cdk.core.Stack`	The stack in which this resource is defined.
`resource`	`com.aliyun.ros.cdk.core.RosResource`	No description.
`attrBakSetId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute BakSetId: The ID of the backup set.
`attrDownloadAddressInfo`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute DownloadAddressInfo: The download address information.
`attrInstanceName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute InstanceName: The ID of the instance.
`attrTaskId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute TaskId: The ID of the download task.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrBakSetId`^Required

public IResolvable getAttrBakSetId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BakSetId: The ID of the backup set.

`attrDownloadAddressInfo`^Required

public IResolvable getAttrDownloadAddressInfo();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DownloadAddressInfo: The download address information.

`attrInstanceName`^Required

public IResolvable getAttrInstanceName();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceName: The ID of the instance.

`attrTaskId`^Required

public IResolvable getAttrTaskId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TaskId: The ID of the download task.

Download

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

formatTypeRequired

instanceNameRequired

bakSetIdOptional

bakSetSizeOptional

bakSetTypeOptional

deleteBackupSetInOssOptional

downloadAddressDurationOptional

downloadPointInTimeOptional

targetBucketOptional

targetOssRegionOptional

targetPathOptional

targetTypeOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata