Skip to content

SynchronizationJob2

This class encapsulates and extends the ROS resource type ALIYUN::DTS::SynchronizationJob2, which is used to configure a data synchronization task.

Initializers 

import com.aliyun.ros.cdk.dts.SynchronizationJob2;
SynchronizationJob2.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)
//  .synchronizationDirection(java.lang.String)
//  .synchronizationDirection(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.
synchronizationDirection java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property synchronizationDirection: The synchronization direction.

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.

Default value: true. Valid values: true and 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.

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

dbListRequired

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

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

destinationEndpointRequired

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

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.

Default value: true. Valid values: true and 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

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 (,). 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.

delayRuleTimeOptional

  • 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.

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 (,). 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.

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.

reserveOptional

  • 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.

statusOptional

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

Property status: The status of the resource.

Valid values:

  • Synchronizing: Start the task.
  • Suspending: Suspend the task.
  • Stopping: Stop the task.

synchronizationDirectionOptional

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

Property synchronizationDirection: The synchronization direction.

Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database. Note: The default value is Forward. The value Reverse takes effect only if the topology of the data synchronization task is two-way synchronization.

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.dts.SynchronizationJob2;
SynchronizationJob2.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.
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.

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

attrDtsInstanceIdRequired 

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

Attribute DtsInstanceId: The ID of the DTS instance.

attrDtsJobIdRequired 

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

Attribute DtsJobId: The ID of the task.

attrDtsJobNameRequired 

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

Attribute DtsJobName: The name of the DTS job.