Download

• Implements: IDownload

This class encapsulates and extends the ROS resource type ALIYUN::DBS::Download.

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();

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 target format of the downloaded data.

Valid values:

• CSV
• SQL
• Parquet
• Bson
• qp.xb

This parameter is required. The Bson format is available only for MongoDB instances. The qp.xb format is available only for ApsaraDB RDS for MySQL instances.

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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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 java.lang.Object getAttrBakSetId();

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

Attribute BakSetId: The ID of the backup set.

attrDownloadAddressInfo^Required

public java.lang.Object getAttrDownloadAddressInfo();

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

Attribute DownloadAddressInfo: The download address information.

attrInstanceName^Required

public java.lang.Object getAttrInstanceName();

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

Attribute InstanceName: The ID of the instance.

attrTaskId^Required

public java.lang.Object getAttrTaskId();

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

Attribute TaskId: The ID of the download task.

props^Required

public DownloadProps getProps();

• Type: DownloadProps