MigrationJob2

This class encapsulates and extends the ROS resource type ALIYUN::DTS::MigrationJob2, which is used to purchase a data migration instance and configure a data migration task of the new version.

Initializers

import com.aliyun.ros.cdk.dts.MigrationJob2;
MigrationJob2.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dataInitialization(java.lang.Boolean)
    .dataInitialization(IResolvable)
    .dataSynchronization(java.lang.Boolean)
    .dataSynchronization(IResolvable)
    .dbList(IResolvable)
    .dbList(java.util.Map<java.lang.String, java.lang.Object>)
    .destinationEndpoint(IResolvable)
    .destinationEndpoint(DestinationEndpointProperty)
    .dtsJobName(java.lang.String)
    .dtsJobName(IResolvable)
    .sourceEndpoint(IResolvable)
    .sourceEndpoint(SourceEndpointProperty)
    .structureInitialization(java.lang.Boolean)
    .structureInitialization(IResolvable)
//  .checkpoint(java.lang.String)
//  .checkpoint(IResolvable)
//  .dataCheckConfigure(IResolvable)
//  .dataCheckConfigure(DataCheckConfigureProperty)
//  .dedicatedClusterId(java.lang.String)
//  .dedicatedClusterId(IResolvable)
//  .delayNotice(java.lang.Boolean)
//  .delayNotice(IResolvable)
//  .delayPhone(java.lang.String)
//  .delayPhone(IResolvable)
//  .delayRuleTime(java.lang.Number)
//  .delayRuleTime(IResolvable)
//  .disasterRecoveryJob(java.lang.Boolean)
//  .disasterRecoveryJob(IResolvable)
//  .dtsBisLabel(java.lang.String)
//  .dtsBisLabel(IResolvable)
//  .dtsInstanceId(java.lang.String)
//  .dtsInstanceId(IResolvable)
//  .dtsJobId(java.lang.String)
//  .dtsJobId(IResolvable)
//  .errorNotice(java.lang.Boolean)
//  .errorNotice(IResolvable)
//  .errorPhone(java.lang.String)
//  .errorPhone(IResolvable)
//  .fileOssUrl(java.lang.String)
//  .fileOssUrl(IResolvable)
//  .reserve(IResolvable)
//  .reserve(java.util.Map<java.lang.String, java.lang.Object>)
//  .status(java.lang.String)
//  .status(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.
`dataInitialization`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property dataInitialization: Specifies whether to perform full data migration or full data synchronization.
`dataSynchronization`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property dataSynchronization: Specifies whether to perform incremental data migration or incremental data synchronization.
`dbList`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.Map`	Property dbList: The objects that you want to migrate or synchronize.
`destinationEndpoint`	`com.aliyun.ros.cdk.core.IResolvable OR DestinationEndpointProperty`	Property destinationEndpoint: Destination instance configuration.
`dtsJobName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dtsJobName: The name of the DTS instance.
`sourceEndpoint`	`com.aliyun.ros.cdk.core.IResolvable OR SourceEndpointProperty`	Property sourceEndpoint: Source instance configuration.
`structureInitialization`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property structureInitialization: Specifies whether to perform schema migration or schema synchronization.
`checkpoint`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property checkpoint: The start offset of incremental data migration or synchronization.
`dataCheckConfigure`	`com.aliyun.ros.cdk.core.IResolvable OR DataCheckConfigureProperty`	Property dataCheckConfigure: The data verification task for a data migration or synchronization instance.
`dedicatedClusterId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dedicatedClusterId: The ID of the DTS dedicated cluster on which the task runs.
`delayNotice`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property delayNotice: Specifies whether to monitor the task latency.
`delayPhone`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property delayPhone: The mobile numbers that receive latency-related alerts.
`delayRuleTime`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property delayRuleTime: The threshold for latency alerts.
`disasterRecoveryJob`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property disasterRecoveryJob: Specifies whether the instance is a disaster recovery instance.
`dtsBisLabel`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dtsBisLabel: The environment tag of the DTS instance.
`dtsInstanceId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dtsInstanceId: The ID of the DTS instance.
`dtsJobId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dtsJobId: The ID of the DTS task.
`errorNotice`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property errorNotice: Specifies whether to monitor the task status.
`errorPhone`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property errorPhone: The mobile numbers that receive status-related alerts.
`fileOssUrl`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property fileOssUrl: The URL of the Object Storage Service (OSS) bucket that stores the files related to the DTS task.
`reserve`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.Map`	Property reserve: The reserved parameter of DTS.
`status`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property status: The status of the resource.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`dataInitialization`^Required

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

Property dataInitialization: Specifies whether to perform full data migration or full data synchronization.

Default value: true. Valid values: true and false.

`dataSynchronization`^Required

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

Property dataSynchronization: Specifies whether to perform incremental data migration or incremental data synchronization.

Default value: false. Valid values: true and false.

`dbList`^Required

Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property dbList: The objects that you want to migrate or synchronize.

`destinationEndpoint`^Required

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

Property destinationEndpoint: Destination instance configuration.

`dtsJobName`^Required

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

Property dtsJobName: The name of the DTS instance.

`sourceEndpoint`^Required

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

Property sourceEndpoint: Source instance configuration.

`structureInitialization`^Required

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

Property structureInitialization: Specifies whether to perform schema migration or schema synchronization.

Default value: true. Valid values: true and false.

`checkpoint`^Optional

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

Property checkpoint: The start offset of incremental data migration or synchronization.

This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.

`dataCheckConfigure`^Optional

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

Property dataCheckConfigure: The data verification task for a data migration or synchronization instance.

`dedicatedClusterId`^Optional

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

Property dedicatedClusterId: The ID of the DTS dedicated cluster on which the task runs.

`delayNotice`^Optional

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

Property delayNotice: Specifies whether to monitor the task latency.

Valid values: true and false

`delayPhone`^Optional

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

Property delayPhone: The mobile numbers that receive latency-related alerts.

Separate multiple mobile numbers with commas (,). Note: This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers, but can configure alert rules for DTS tasks in the CloudMonitor console.

`delayRuleTime`^Optional

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

Property delayRuleTime: The threshold for latency alerts.

Unit: seconds. You can set the threshold based on your business requirements. To prevent jitters caused by network and database overloads, we recommend that you set the threshold to more than 10 seconds.

`disasterRecoveryJob`^Optional

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

Property disasterRecoveryJob: Specifies whether the instance is a disaster recovery instance.

Valid values: true and false

`dtsBisLabel`^Optional

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

Property dtsBisLabel: The environment tag of the DTS instance.

Valid values: normal and online.

`dtsInstanceId`^Optional

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

Property dtsInstanceId: The ID of the DTS instance.

`dtsJobId`^Optional

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

Property dtsJobId: The ID of the DTS task.

`errorNotice`^Optional

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

Property errorNotice: Specifies whether to monitor the task status.

Valid values: true and false.

`errorPhone`^Optional

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

Property errorPhone: The mobile numbers that receive status-related alerts.

Separate multiple mobile numbers with commas (,). Note: This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers, but can configure alert rules for DTS tasks in the CloudMonitor console.

`fileOssUrl`^Optional

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

Property fileOssUrl: The URL of the Object Storage Service (OSS) bucket that stores the files related to the DTS task.

`reserve`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property reserve: The reserved parameter of DTS.

You can specify this parameter to add more configurations of the source or destination instance to the DTS task. For example, you can specify the data storage format of the destination Kafka database and the ID of the CEN instance.

`status`^Optional

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

Property status: The status of the resource.

Valid values:

Migrating: Start the task.
Suspending: Suspend the task.
Stopping: Stop the task.

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.dts.MigrationJob2;
MigrationJob2.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.
`attrDtsInstanceId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute DtsInstanceId: The ID of the DTS instance.
`attrDtsJobId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute DtsJobId: The ID of the task.
`attrDtsJobName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute DtsJobName: The name of the DTS job.

`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

`attrDtsInstanceId`^Required

public IResolvable getAttrDtsInstanceId();

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

Attribute DtsInstanceId: The ID of the DTS instance.

`attrDtsJobId`^Required

public IResolvable getAttrDtsJobId();

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

Attribute DtsJobId: The ID of the task.

`attrDtsJobName`^Required

public IResolvable getAttrDtsJobName();

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

Attribute DtsJobName: The name of the DTS job.

MigrationJob2

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

dataInitializationRequired

dataSynchronizationRequired

dbListRequired

destinationEndpointRequired

dtsJobNameRequired

sourceEndpointRequired

structureInitializationRequired

checkpointOptional

dataCheckConfigureOptional

dedicatedClusterIdOptional

delayNoticeOptional

delayPhoneOptional

delayRuleTimeOptional

disasterRecoveryJobOptional

dtsBisLabelOptional

dtsInstanceIdOptional

dtsJobIdOptional

errorNoticeOptional

errorPhoneOptional

fileOssUrlOptional

reserveOptional

statusOptional