ALIYUN::DTS::SynchronizationJob2 is used to configure a data synchronization task.
Syntax
{
"Type": "ALIYUN::DTS::SynchronizationJob2",
"Properties": {
"Status": String,
"Reserve": Map,
"DataSynchronization": Boolean,
"DelayPhone": String,
"DedicatedClusterId": String,
"ErrorNotice": Boolean,
"DtsJobName": String,
"DelayRuleTime": Integer,
"DtsInstanceId": String,
"DbList": Map,
"FileOssUrl": String,
"DataCheckConfigure": Map,
"DtsBisLabel": String,
"Checkpoint": String,
"DisasterRecoveryJob": Boolean,
"DtsJobId": String,
"DelayNotice": Boolean,
"DataInitialization": Boolean,
"DestinationEndpoint": Map,
"SourceEndpoint": Map,
"ErrorPhone": String,
"StructureInitialization": Boolean,
"SynchronizationDirection": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
Status | String | No | Yes | The status of the data synchronization task. | Valid values:
|
Reserve | Map | No | Yes | The reserved property of Data Transmission Service (DTS). | You can use this property to add more configurations of the source or destination instance to DTS tasks. For example, you can specify the data storage format of a destination ApsaraMQ for Kafka database and the ID of a destination Cloud Enterprise Network (CEN) instance. |
DataSynchronization | Boolean | Yes | Yes | Specifies whether to perform incremental data migration or incremental data synchronization. | Valid values:
|
DelayPhone | String | No | No | The mobile numbers to which latency-related alerts are sent. | Separate multiple mobile numbers with commas (,). Note
|
DedicatedClusterId | String | No | No | The ID of the DTS dedicated cluster. | You can schedule the data synchronization task to the DTS dedicated cluster. |
ErrorNotice | Boolean | No | No | Specifies whether to monitor the task status. | Valid values:
|
DtsJobName | String | Yes | Yes | The name of the data synchronization task. | We recommend that you specify a descriptive name for easy identification. You do not need to use a unique name. |
DelayRuleTime | Integer | No | No | The threshold for triggering latency-related alerts. | Unit: seconds. The value must be an integer. 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. Note You must specify this property when DelayNotice is set to true. |
DtsInstanceId | String | No | No | The ID of the data synchronization instance. | None. |
DbList | Map | Yes | Yes | The objects whose data you want to synchronize. | The value is a JSON string. For more information, see Objects of DTS tasks. |
FileOssUrl | String | No | Yes | The URL of the Object Storage Service (OSS) bucket that you want to use to store files of the data synchronization task. | None. |
DataCheckConfigure | Map | No | No | The data verification task for the data migration or synchronization instance. | The value is a JSON string. You can use this property to configure information such as parameter limits or alert configurations. For more information, see DataCheckConfigure properties. |
DtsBisLabel | String | No | No | The environment tag of the DTS instance. | Valid values:
|
Checkpoint | String | No | No | The start offset of incremental data migration or incremental data synchronization. | This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: seconds. |
DisasterRecoveryJob | Boolean | No | No | Specifies whether the instance is a disaster recovery instance. | Valid values:
|
DtsJobId | String | No | No | The ID of the data synchronization task. | None. |
DelayNotice | Boolean | No | No | Specifies whether to monitor the task latency. | Valid values:
|
DataInitialization | Boolean | Yes | Yes | Specifies whether to perform full data migration or initial full data synchronization. | Valid values:
|
DestinationEndpoint | Map | Yes | Yes | The configurations of the destination instance. | For more information, see DestinationEndpoint properties. |
SourceEndpoint | Map | Yes | Yes | The configurations of the source instance. | For more information, see SourceEndpoint properties. |
ErrorPhone | String | No | No | The mobile numbers to which status-related alerts are sent. | Separate multiple mobile numbers with commas (,). Note
|
StructureInitialization | Boolean | Yes | Yes | Specifies whether to perform schema migration or initial schema synchronization. | Valid values:
|
SynchronizationDirection | String | No | Yes | The synchronization direction. | Valid values:
Note The value Reverse takes effect only when the topology of the data synchronization task is two-way synchronization. |
DataCheckConfigure syntax
"DataCheckConfigure": {
"fullCheckMaxReadRps": Integer,
"dataCheckNoticePhone": String,
"incrementalCheckDelayNotice": Boolean,
"incrementalCheckDelayNoticeValue": Integer,
"incrementalCheckDelayNoticePeriod": Integer,
"dataCheckDbList": String,
"checkMaximumHourEnable": Integer,
"fullCheckRatio": Integer,
"checkMaximumHour": Integer,
"fullCheckFixData": Boolean,
"fullCheckModel": Integer,
"incrementalCheckValidFailNoticeValue": Integer,
"incrementalDataCheck": Boolean,
"incrementalCheckValidFailNoticeTimes": Integer,
"fullCheckMaxReadBps": Integer,
"fullCheckValidFailNotice": Boolean,
"fullCheckErrorNotice": Boolean,
"incrementalCheckValidFailNoticePeriod": Integer,
"incrementalCheckDelayNoticeTimes": Integer,
"fullCheckReferEndpoint": String,
"fullDataCheck": Boolean,
"incrementalCheckValidFailNotice": Boolean,
"fullCheckNoticeValue": Integer,
"incrementalCheckErrorNotice": Boolean
}
DataCheckConfigure properties
Property | Type | Required | Editable | Description | Constraint |
fullCheckMaxReadRps | Integer | No | No | The maximum number of rows that are read per second. | Valid values: 0 to 9007199254740991. The value must be an integer. Note A value of 0 indicates that no limit is imposed. |
dataCheckNoticePhone | String | No | No | The mobile number of the alert contact for the full or incremental data verification task. | If an alert is triggered on a data verification task, DTS sends alert notifications to the alert contact by using text messages. |
incrementalCheckDelayNotice | Boolean | No | No | Specifies whether to trigger an alert on the data latency of the incremental data verification task. | Valid values:
|
incrementalCheckDelayNoticeValue | Integer | No | No | The alert threshold for the data latency of the incremental data verification task. | Unit: seconds. Note You must specify this property when incrementalCheckDelayNotice is set to true. |
incrementalCheckDelayNoticePeriod | Integer | No | No | The statistical period of an alert on the data latency of the incremental data verification task. | Valid values:
Note You must specify this property when incrementalCheckDelayNotice is set to true. |
dataCheckDbList | String | No | No | The objects whose data you want to verify. | None. |
checkMaximumHourEnable | Integer | No | No | Specifies whether to configure a timeout period for the full data verification task. | Valid values:
Note You must specify this property when fullCheckModel is set to 1. |
fullCheckRatio | Integer | No | No | The sampling ratio of the full data verification task. | Valid values: 10 to 100. The value must be an integer. Unit: percent. Note You must specify this property when fullCheckModel is set to 1. |
checkMaximumHour | Integer | No | No | The timeout period of the full data verification task. | Valid values: 1 to 72. The value must be an integer. A countdown begins the moment the full data verification task is started. If the task is not complete within the specified timeout period, the task is forcefully stopped. |
fullCheckFixData | Boolean | No | No | Specifies whether to replace the inconsistent data. | Valid values:
|
fullCheckModel | Integer | No | No | The mode of the full data verification task. | Valid values:
|
incrementalCheckValidFailNoticeValue | Integer | No | No | The alert threshold for inconsistent data entries that are detected by the incremental data verification task. | You must specify this property when incrementalCheckValidFailNotice is set to true. |
incrementalDataCheck | Boolean | No | No | Specifies whether to perform incremental data verification. | Valid values:
|
incrementalCheckValidFailNoticeTimes | Integer | No | No | The number of statistical periods of an alert on inconsistent data entries that are detected by the incremental data verification task. | You must specify this property when incrementalCheckValidFailNotice is set to true. |
fullCheckMaxReadBps | Integer | No | No | The maximum amount of data that is read per second. Unit: bytes. | Valid values: 0 to 9007199254740991. The value must be an integer. Note A value of 0 indicates that no limit is imposed. |
fullCheckValidFailNotice | Boolean | No | No | Specifies whether to trigger an alert if inconsistent data is detected by the full data verification task. | Valid values:
|
fullCheckErrorNotice | Boolean | No | No | Specifies whether to trigger an alert if the full data verification task fails. | Valid values:
|
incrementalCheckValidFailNoticePeriod | Integer | No | No | The statistical period of an alert on inconsistent data entries that are detected by the incremental data verification task. | Valid values:
Note You must specify this property when incrementalCheckValidFailNotice is set to true. |
incrementalCheckDelayNoticeTimes | Integer | No | No | The number of statistical periods of an alert on the data latency of the incremental data verification task. | You must specify this property when incrementalCheckDelayNotice is set to true. |
fullCheckReferEndpoint | String | No | No | The benchmark for full data verification. | Valid values:
|
fullDataCheck | Boolean | No | No | Specifies whether to perform full data verification. | Valid values:
|
incrementalCheckValidFailNotice | Boolean | No | No | Specifies whether to trigger an alert if inconsistent data is detected by the incremental data verification task. | Valid values:
|
fullCheckNoticeValue | Integer | No | No | The alert threshold for inconsistent data entries that are detected by the full data verification task. | You must specify this property when fullCheckValidFailNotice is set to true. |
incrementalCheckErrorNotice | Boolean | No | No | Specifies whether to trigger an alert if the incremental data verification task fails. | Valid values:
|
DestinationEndpoint syntax
"DestinationEndpoint": {
"Role": String,
"OracleSID": String,
"UserName": String,
"OwnerID": String,
"InstanceID": String,
"IP": String,
"Port": String,
"DatabaseName": String,
"Region": String,
"InstanceType": String,
"EngineName": String,
"Password": String
}
DestinationEndpoint properties
Property | Type | Required | Editable | Description | Constraint |
Role | String | No | No | The name of the Resource Access Management (RAM) role for the Alibaba Cloud account that owns the destination instance. | You must specify this property when you migrate or synchronize data across different Alibaba Cloud accounts. |
OracleSID | String | No | No | The system ID (SID) of the Oracle database. | You must specify this property only when DestinationEndpoint.EngineName is set to Oracle and the Oracle database is not deployed in the Real Application Clusters (RAC) architecture. |
UserName | String | No | No | The database account of the destination database. | The permissions that are required for the database account vary based on migration scenarios. For more information, see Overview of data migration scenarios. |
OwnerID | String | No | No | The ID of the Alibaba Cloud account to which the destination database belongs. | You must specify this property only when you configure data migration across different Alibaba Cloud accounts. |
InstanceID | String | No | No | The ID of the destination instance. | You must specify this property only when DestinationEndpoint.InstanceType is set to RDS, ECS, MongoDB, Redis, DRDS, PetaData, OceanBase, PolarDB, PolarDB_o, AnalyticDB, or Greenplum. For example, if DestinationEndpoint.InstanceType is set to ECS, you must set DestinationEndpoint.InstanceID to the ID of an Elastic Compute Service (ECS) instance. |
IP | String | No | No | The IP address of the destination database. | You must specify this property only when DestinationEndpoint.InstanceType is set to LocalInstance or Express. |
Port | String | No | No | The service port of the destination database. | You must specify this property only when DestinationEndpoint.InstanceType is set to ECS, LocalInstance, or Express. |
DatabaseName | String | No | No | The name of the destination database or authentication database. |
|
Region | String | No | No | The region ID of the destination database. | If DestinationEndpoint.InstanceType is set to LocalInstance, you can set DestinationEndpoint.Region to cn-hangzhou or the ID of the region that is closest to the region of the self-managed database. For more information, see Supported regions. |
InstanceType | String | Yes | No | The type of the destination instance. | Valid values:
|
EngineName | String | No | No | The engine type of the destination database. | Valid values:
Note You must specify this property only when DestionationEndpoint.InstanceType is set to RDS, PolarDB, ECS, LocalInstance, or Express. |
Password | String | No | Yes | The password of the destination database account. | None. |
SourceEndpoint syntax
"SourceEndpoint": {
"OracleSID": String,
"UserName": String,
"InstanceID": String,
"IP": String,
"Port": String,
"VSwitchID": String,
"DatabaseName": String,
"EngineName": String,
"Role": String,
"OwnerID": String,
"Region": String,
"InstanceType": String,
"Password": String
}
SourceEndpoint properties
Property | Type | Required | Editable | Description | Constraint |
OracleSID | String | No | No | The SID of the Oracle database. | You must specify this property only when SourceEndpoint.EngineName is set to Oracle and the Oracle database is not deployed in the RAC architecture. |
UserName | String | No | No | The database account of the source database. | The permissions that are required for the database account vary based on migration scenarios. For more information, see Overview of data migration scenarios. |
InstanceID | String | No | No | The ID of the instance that hosts the source database. |
|
IP | String | No | No | The IP address of the source database. | You must specify this property only when SourceEndpoint.InstanceType is set to LocalInstance or Express. |
Port | String | No | No | The service port of the source database. | You must specify this property only when SourceEndpoint.InstanceType is set to ECS, LocalInstance, or Express. |
VSwitchID | String | No | No | The ID of the vSwitch that you want to use for the data transmission link. | None. |
DatabaseName | String | No | No | The name of the source database or authentication database. |
|
EngineName | String | No | No | The engine type of the source database. | Valid values:
Note You must specify this property only when SourceEndpoint.InstanceType is set to RDS, PolarDB, ECS, LocalInstance, or Express. |
Role | String | No | No | The RAM role of the source instance. | You must specify this property when the source and destination instances belong to different Alibaba Cloud accounts. You can use the RAM role to authorize the Alibaba Cloud account that owns the destination instance to access the source instance. Note For more information about the permissions required by the RAM role and how to grant the permissions, see Configure RAM authorization for cross-account DTS tasks. |
OwnerID | String | No | No | The ID of the Alibaba Cloud account to which the source instance belongs. | You must specify this property only when you configure data migration across different Alibaba Cloud accounts. |
Region | String | No | No | The region ID of the source database. | If SourceEndpoint.InstanceType is set to LocalInstance, you can set SourceEndpoint.Region to cn-hangzhou or the ID of the region that is closest to the region of the self-managed database. For more information, see Supported regions. |
InstanceType | String | Yes | No | The type of the source instance. | Valid values:
|
Password | String | No | Yes | The password of the source database account. | None. |
Return values
Fn::GetAtt
DtsJobId: the ID of the data synchronization task.
DtsJobName: the name of the data synchronization task.
DtsInstanceId: the ID of the data synchronization instance.