MigrationJob2
- Implements: IMigrationJob2
This class encapsulates and extends the ROS resource type ALIYUN::DTS::MigrationJob2.
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)
// .destPrimaryVswId(java.lang.String)
// .destPrimaryVswId(IResolvable)
// .destSecondaryVswId(java.lang.String)
// .destSecondaryVswId(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)
// .maxDu(java.lang.Number)
// .maxDu(IResolvable)
// .minDu(java.lang.Number)
// .minDu(IResolvable)
// .reserve(IResolvable)
// .reserve(java.util.Map<java.lang.String, java.lang.Object>)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .srcPrimaryVswId(java.lang.String)
// .srcPrimaryVswId(IResolvable)
// .srcSecondaryVswId(java.lang.String)
// .srcSecondaryVswId(IResolvable)
// .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. |
destPrimaryVswId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property destPrimaryVswId: The primary VSW ID at the destination end of the VPC NAT. |
destSecondaryVswId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property destSecondaryVswId: The secondary VSW ID at the destination end of the VPC NAT. |
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. |
maxDu | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property maxDu: The DU upper limit of the Serverless instance, with values being: 2, 4, 8, 16. |
minDu | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property minDu: The lower limit of DU for Serverless instances, with values being: 1, 2, 4, 8, 16. |
reserve | com.aliyun.ros.cdk.core.IResolvable OR java.util.Map | Property reserve: The reserved parameter of DTS. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group. |
srcPrimaryVswId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property srcPrimaryVswId: The primary VSW ID at the source end of the VPC NAT. |
srcSecondaryVswId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property srcSecondaryVswId: The secondary VSW ID at the source end of the VPC NAT. |
status | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property status: The status of the resource. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
dataInitializationRequired
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property dataInitialization: Specifies whether to perform full data migration or full data synchronization.
Valid values:
- true (default)
- false
If JobType is set to CHECK, set this parameter to false.
dataSynchronizationRequired
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property dataSynchronization: Specifies whether to perform incremental data migration or incremental data synchronization.
Valid values:
- false (default)
- true
If JobType is set to CHECK, set this parameter to false.
dbListRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property dbList: The objects that you want to migrate or synchronize.
The value is a JSON string.
destinationEndpointRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR DestinationEndpointProperty
Property destinationEndpoint: Destination instance configuration.
dtsJobNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dtsJobName: The name of the DTS instance.
sourceEndpointRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR SourceEndpointProperty
Property sourceEndpoint: Source instance configuration.
structureInitializationRequired
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property structureInitialization: Specifies whether to perform schema migration or schema synchronization.
Valid values:
- true (default)
- false
If JobType is set to CHECK, set this parameter to false.
checkpointOptional
- 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.
dataCheckConfigureOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR DataCheckConfigureProperty
Property dataCheckConfigure: The data verification task for a data migration or synchronization instance.
dedicatedClusterIdOptional
- 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.
delayNoticeOptional
- 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
delayPhoneOptional
- 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 (,). You can specify up to 10 mobile numbers. Note: You can also configure alert rules for DTS tasks in the CloudMonitor console.This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers.
delayRuleTimeOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property delayRuleTime: The threshold for latency alerts.
Unit: seconds. The value must be an integer. You can set the threshold based on your business requirements. To prevent unstable latency caused by network and database overloads, we recommend that you set the threshold to more than 10 seconds.
If DelayNotice is set to true, this parameter is required.
destPrimaryVswIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property destPrimaryVswId: The primary VSW ID at the destination end of the VPC NAT.
destSecondaryVswIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property destSecondaryVswId: The secondary VSW ID at the destination end of the VPC NAT.
disasterRecoveryJobOptional
- 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
dtsBisLabelOptional
- 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.
dtsInstanceIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dtsInstanceId: The ID of the DTS instance.
dtsJobIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dtsJobId: The ID of the DTS task.
errorNoticeOptional
- 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.
errorPhoneOptional
- 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 (,). You can specify up to 10 mobile numbers. Note: You can also configure alert rules for DTS tasks in the CloudMonitor console.This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers.
fileOssUrlOptional
- 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.
maxDuOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property maxDu: The DU upper limit of the Serverless instance, with values being: 2, 4, 8, 16.
Currently, this feature is not supported, please do not pass in parameters.
minDuOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property minDu: The lower limit of DU for Serverless instances, with values being: 1, 2, 4, 8, 16.
This feature is currently not supported, please do not pass in parameters.
reserveOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property reserve: The reserved parameter of DTS.
The value is a JSON string. 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 CEN instance ID.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
srcPrimaryVswIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property srcPrimaryVswId: The primary VSW ID at the source end of the VPC NAT.
srcSecondaryVswIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property srcSecondaryVswId: The secondary VSW ID at the source end of the VPC NAT.
statusOptional
- 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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DtsInstanceId: The ID of the DTS instance. |
attrDtsJobId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DtsJobId: The ID of the task. |
attrDtsJobName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DtsJobName: The name of the DTS job. |
props | MigrationJob2Props | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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
attrDtsInstanceIdRequired
public java.lang.Object getAttrDtsInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DtsInstanceId: The ID of the DTS instance.
attrDtsJobIdRequired
public java.lang.Object getAttrDtsJobId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DtsJobId: The ID of the task.
attrDtsJobNameRequired
public java.lang.Object getAttrDtsJobName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DtsJobName: The name of the DTS job.
propsRequired
public MigrationJob2Props getProps();
- Type: MigrationJob2Props