Skip to content

MigrateTask

This class encapsulates and extends the ROS resource type ALIYUN::RDS::MigrateTask, which is used to create a migration task to restore backup files from an Object Storage Service (OSS) bucket to an ApsaraDB RDS for SQL Server instance.

Initializers 

import com.aliyun.ros.cdk.rds.MigrateTask;
MigrateTask.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .backupMode(java.lang.String)
    .backupMode(IResolvable)
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
    .dbName(java.lang.String)
    .dbName(IResolvable)
    .isOnlineDb(java.lang.Boolean)
    .isOnlineDb(IResolvable)
//  .checkDbMode(java.lang.String)
//  .checkDbMode(IResolvable)
//  .ossObjectPositions(java.lang.String)
//  .ossObjectPositions(IResolvable)
//  .ossUrls(java.lang.String)
//  .ossUrls(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.
backupMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupMode: The type of the migration task.
dbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceId: The ID of the instance.
dbName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbName: The name of the database that you want to restore.
isOnlineDb java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isOnlineDb: Specifies whether to bring the restored database online for user access.
checkDbMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property checkDbMode: The consistency check method of the database.
ossObjectPositions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ossObjectPositions: The information of the backup file in the OSS bucket.
ossUrls java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ossUrls: The shared URL of the backup file in the OSS bucket.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

backupModeRequired

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

Property backupMode: The type of the migration task.

Valid values: FULL: specifies that full backup files are used to restore data. UPDF: specifies that incremental backup files or log files are used to restore incremental data.

dbInstanceIdRequired

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

Property dbInstanceId: The ID of the instance.

dbNameRequired

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

Property dbName: The name of the database that you want to restore.

isOnlineDbRequired

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

Property isOnlineDb: Specifies whether to bring the restored database online for user access.

Note The value for SQL Server 2008 R2 is fixed to True.

checkDbModeOptional

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

Property checkDbMode: The consistency check method of the database.

Valid values: SyncExecuteDBCheck: synchronous database check AsyncExecuteDBCheck: asynchronous database check Default value: AsyncExecuteDBCheck (compatible with SQL Server 2008 R2). Note When IsOnlineDB is set to True, this value is valid.

ossObjectPositionsOptional

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

Property ossObjectPositions: The information of the backup file in the OSS bucket.

The values consist of three parts that are separated by colons (:): The endpoint of the OSS bucket: oss-ap-southeast-1.aliyuncs.com. The name of the OSS bucket: rdsmssqlsingapore. The key of the backup file in the OSS bucket: autotest_2008R2_TestMigration_FULL.bak. Note This parameter is optional for instances that run SQL Server 2008 R2. This parameter is required for instances that run a database engine later than SQL Server 2008 R2.

ossUrlsOptional

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

Property ossUrls: The shared URL of the backup file in the OSS bucket.

The URL must be encoded. If you specify multiple URLs, separate them with vertical bars (|) and then encode them. Note This parameter must be entered for instances that run SQL Server 2008 R2.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.rds.MigrateTask;
MigrateTask.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • 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.
attrDbName com.aliyun.ros.cdk.core.IResolvable Attribute DBName: The name of the database that you want to restore.
attrMigrateTaskId com.aliyun.ros.cdk.core.IResolvable Attribute MigrateTaskId: The ID of the migrate task.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrDbNameRequired 

public IResolvable getAttrDbName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBName: The name of the database that you want to restore.

attrMigrateTaskIdRequired 

public IResolvable getAttrMigrateTaskId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MigrateTaskId: The ID of the migrate task.