alicloud.dts.SynchronizationJob
Explore with Pulumi AI
Provides a DTS Synchronization Job resource.
For information about DTS Synchronization Job and how to use it, see What is Synchronization Job.
NOTE: Available since v1.138.0.
Create SynchronizationJob Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SynchronizationJob(name: string, args: SynchronizationJobArgs, opts?: CustomResourceOptions);
@overload
def SynchronizationJob(resource_name: str,
args: SynchronizationJobArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SynchronizationJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
destination_endpoint_engine_name: Optional[str] = None,
structure_initialization: Optional[bool] = None,
data_initialization: Optional[bool] = None,
data_synchronization: Optional[bool] = None,
db_list: Optional[str] = None,
source_endpoint_instance_type: Optional[str] = None,
source_endpoint_engine_name: Optional[str] = None,
dts_job_name: Optional[str] = None,
dts_instance_id: Optional[str] = None,
destination_endpoint_instance_type: Optional[str] = None,
destination_endpoint_instance_id: Optional[str] = None,
reserve: Optional[str] = None,
destination_endpoint_database_name: Optional[str] = None,
destination_endpoint_ip: Optional[str] = None,
destination_endpoint_oracle_sid: Optional[str] = None,
destination_endpoint_owner_id: Optional[str] = None,
destination_endpoint_password: Optional[str] = None,
destination_endpoint_port: Optional[str] = None,
destination_endpoint_region: Optional[str] = None,
destination_endpoint_role: Optional[str] = None,
destination_endpoint_user_name: Optional[str] = None,
dts_bis_label: Optional[str] = None,
delay_rule_time: Optional[str] = None,
delay_phone: Optional[str] = None,
error_notice: Optional[bool] = None,
error_phone: Optional[str] = None,
instance_class: Optional[str] = None,
checkpoint: Optional[str] = None,
source_endpoint_database_name: Optional[str] = None,
delay_notice: Optional[bool] = None,
source_endpoint_instance_id: Optional[str] = None,
dedicated_cluster_id: Optional[str] = None,
source_endpoint_ip: Optional[str] = None,
source_endpoint_oracle_sid: Optional[str] = None,
source_endpoint_owner_id: Optional[str] = None,
source_endpoint_password: Optional[str] = None,
source_endpoint_port: Optional[str] = None,
source_endpoint_region: Optional[str] = None,
source_endpoint_role: Optional[str] = None,
source_endpoint_user_name: Optional[str] = None,
source_endpoint_vswitch_id: Optional[str] = None,
status: Optional[str] = None,
data_check_configure: Optional[str] = None,
synchronization_direction: Optional[str] = None)
func NewSynchronizationJob(ctx *Context, name string, args SynchronizationJobArgs, opts ...ResourceOption) (*SynchronizationJob, error)
public SynchronizationJob(string name, SynchronizationJobArgs args, CustomResourceOptions? opts = null)
public SynchronizationJob(String name, SynchronizationJobArgs args)
public SynchronizationJob(String name, SynchronizationJobArgs args, CustomResourceOptions options)
type: alicloud:dts:SynchronizationJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SynchronizationJobArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. SynchronizationJobArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SynchronizationJobArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SynchronizationJobArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. SynchronizationJobArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var synchronizationJobResource = new AliCloud.Dts.SynchronizationJob("synchronizationJobResource", new()
{
DestinationEndpointEngineName = "string",
StructureInitialization = false,
DataInitialization = false,
DataSynchronization = false,
DbList = "string",
SourceEndpointInstanceType = "string",
SourceEndpointEngineName = "string",
DtsJobName = "string",
DtsInstanceId = "string",
DestinationEndpointInstanceType = "string",
DestinationEndpointInstanceId = "string",
Reserve = "string",
DestinationEndpointDatabaseName = "string",
DestinationEndpointIp = "string",
DestinationEndpointOracleSid = "string",
DestinationEndpointOwnerId = "string",
DestinationEndpointPassword = "string",
DestinationEndpointPort = "string",
DestinationEndpointRegion = "string",
DestinationEndpointRole = "string",
DestinationEndpointUserName = "string",
DtsBisLabel = "string",
DelayRuleTime = "string",
DelayPhone = "string",
ErrorNotice = false,
ErrorPhone = "string",
InstanceClass = "string",
Checkpoint = "string",
SourceEndpointDatabaseName = "string",
DelayNotice = false,
SourceEndpointInstanceId = "string",
DedicatedClusterId = "string",
SourceEndpointIp = "string",
SourceEndpointOracleSid = "string",
SourceEndpointOwnerId = "string",
SourceEndpointPassword = "string",
SourceEndpointPort = "string",
SourceEndpointRegion = "string",
SourceEndpointRole = "string",
SourceEndpointUserName = "string",
SourceEndpointVswitchId = "string",
Status = "string",
DataCheckConfigure = "string",
SynchronizationDirection = "string",
});
example, err := dts.NewSynchronizationJob(ctx, "synchronizationJobResource", &dts.SynchronizationJobArgs{
DestinationEndpointEngineName: pulumi.String("string"),
StructureInitialization: pulumi.Bool(false),
DataInitialization: pulumi.Bool(false),
DataSynchronization: pulumi.Bool(false),
DbList: pulumi.String("string"),
SourceEndpointInstanceType: pulumi.String("string"),
SourceEndpointEngineName: pulumi.String("string"),
DtsJobName: pulumi.String("string"),
DtsInstanceId: pulumi.String("string"),
DestinationEndpointInstanceType: pulumi.String("string"),
DestinationEndpointInstanceId: pulumi.String("string"),
Reserve: pulumi.String("string"),
DestinationEndpointDatabaseName: pulumi.String("string"),
DestinationEndpointIp: pulumi.String("string"),
DestinationEndpointOracleSid: pulumi.String("string"),
DestinationEndpointOwnerId: pulumi.String("string"),
DestinationEndpointPassword: pulumi.String("string"),
DestinationEndpointPort: pulumi.String("string"),
DestinationEndpointRegion: pulumi.String("string"),
DestinationEndpointRole: pulumi.String("string"),
DestinationEndpointUserName: pulumi.String("string"),
DtsBisLabel: pulumi.String("string"),
DelayRuleTime: pulumi.String("string"),
DelayPhone: pulumi.String("string"),
ErrorNotice: pulumi.Bool(false),
ErrorPhone: pulumi.String("string"),
InstanceClass: pulumi.String("string"),
Checkpoint: pulumi.String("string"),
SourceEndpointDatabaseName: pulumi.String("string"),
DelayNotice: pulumi.Bool(false),
SourceEndpointInstanceId: pulumi.String("string"),
DedicatedClusterId: pulumi.String("string"),
SourceEndpointIp: pulumi.String("string"),
SourceEndpointOracleSid: pulumi.String("string"),
SourceEndpointOwnerId: pulumi.String("string"),
SourceEndpointPassword: pulumi.String("string"),
SourceEndpointPort: pulumi.String("string"),
SourceEndpointRegion: pulumi.String("string"),
SourceEndpointRole: pulumi.String("string"),
SourceEndpointUserName: pulumi.String("string"),
SourceEndpointVswitchId: pulumi.String("string"),
Status: pulumi.String("string"),
DataCheckConfigure: pulumi.String("string"),
SynchronizationDirection: pulumi.String("string"),
})
var synchronizationJobResource = new SynchronizationJob("synchronizationJobResource", SynchronizationJobArgs.builder()
.destinationEndpointEngineName("string")
.structureInitialization(false)
.dataInitialization(false)
.dataSynchronization(false)
.dbList("string")
.sourceEndpointInstanceType("string")
.sourceEndpointEngineName("string")
.dtsJobName("string")
.dtsInstanceId("string")
.destinationEndpointInstanceType("string")
.destinationEndpointInstanceId("string")
.reserve("string")
.destinationEndpointDatabaseName("string")
.destinationEndpointIp("string")
.destinationEndpointOracleSid("string")
.destinationEndpointOwnerId("string")
.destinationEndpointPassword("string")
.destinationEndpointPort("string")
.destinationEndpointRegion("string")
.destinationEndpointRole("string")
.destinationEndpointUserName("string")
.dtsBisLabel("string")
.delayRuleTime("string")
.delayPhone("string")
.errorNotice(false)
.errorPhone("string")
.instanceClass("string")
.checkpoint("string")
.sourceEndpointDatabaseName("string")
.delayNotice(false)
.sourceEndpointInstanceId("string")
.dedicatedClusterId("string")
.sourceEndpointIp("string")
.sourceEndpointOracleSid("string")
.sourceEndpointOwnerId("string")
.sourceEndpointPassword("string")
.sourceEndpointPort("string")
.sourceEndpointRegion("string")
.sourceEndpointRole("string")
.sourceEndpointUserName("string")
.sourceEndpointVswitchId("string")
.status("string")
.dataCheckConfigure("string")
.synchronizationDirection("string")
.build());
synchronization_job_resource = alicloud.dts.SynchronizationJob("synchronizationJobResource",
destination_endpoint_engine_name="string",
structure_initialization=False,
data_initialization=False,
data_synchronization=False,
db_list="string",
source_endpoint_instance_type="string",
source_endpoint_engine_name="string",
dts_job_name="string",
dts_instance_id="string",
destination_endpoint_instance_type="string",
destination_endpoint_instance_id="string",
reserve="string",
destination_endpoint_database_name="string",
destination_endpoint_ip="string",
destination_endpoint_oracle_sid="string",
destination_endpoint_owner_id="string",
destination_endpoint_password="string",
destination_endpoint_port="string",
destination_endpoint_region="string",
destination_endpoint_role="string",
destination_endpoint_user_name="string",
dts_bis_label="string",
delay_rule_time="string",
delay_phone="string",
error_notice=False,
error_phone="string",
instance_class="string",
checkpoint="string",
source_endpoint_database_name="string",
delay_notice=False,
source_endpoint_instance_id="string",
dedicated_cluster_id="string",
source_endpoint_ip="string",
source_endpoint_oracle_sid="string",
source_endpoint_owner_id="string",
source_endpoint_password="string",
source_endpoint_port="string",
source_endpoint_region="string",
source_endpoint_role="string",
source_endpoint_user_name="string",
source_endpoint_vswitch_id="string",
status="string",
data_check_configure="string",
synchronization_direction="string")
const synchronizationJobResource = new alicloud.dts.SynchronizationJob("synchronizationJobResource", {
destinationEndpointEngineName: "string",
structureInitialization: false,
dataInitialization: false,
dataSynchronization: false,
dbList: "string",
sourceEndpointInstanceType: "string",
sourceEndpointEngineName: "string",
dtsJobName: "string",
dtsInstanceId: "string",
destinationEndpointInstanceType: "string",
destinationEndpointInstanceId: "string",
reserve: "string",
destinationEndpointDatabaseName: "string",
destinationEndpointIp: "string",
destinationEndpointOracleSid: "string",
destinationEndpointOwnerId: "string",
destinationEndpointPassword: "string",
destinationEndpointPort: "string",
destinationEndpointRegion: "string",
destinationEndpointRole: "string",
destinationEndpointUserName: "string",
dtsBisLabel: "string",
delayRuleTime: "string",
delayPhone: "string",
errorNotice: false,
errorPhone: "string",
instanceClass: "string",
checkpoint: "string",
sourceEndpointDatabaseName: "string",
delayNotice: false,
sourceEndpointInstanceId: "string",
dedicatedClusterId: "string",
sourceEndpointIp: "string",
sourceEndpointOracleSid: "string",
sourceEndpointOwnerId: "string",
sourceEndpointPassword: "string",
sourceEndpointPort: "string",
sourceEndpointRegion: "string",
sourceEndpointRole: "string",
sourceEndpointUserName: "string",
sourceEndpointVswitchId: "string",
status: "string",
dataCheckConfigure: "string",
synchronizationDirection: "string",
});
type: alicloud:dts:SynchronizationJob
properties:
checkpoint: string
dataCheckConfigure: string
dataInitialization: false
dataSynchronization: false
dbList: string
dedicatedClusterId: string
delayNotice: false
delayPhone: string
delayRuleTime: string
destinationEndpointDatabaseName: string
destinationEndpointEngineName: string
destinationEndpointInstanceId: string
destinationEndpointInstanceType: string
destinationEndpointIp: string
destinationEndpointOracleSid: string
destinationEndpointOwnerId: string
destinationEndpointPassword: string
destinationEndpointPort: string
destinationEndpointRegion: string
destinationEndpointRole: string
destinationEndpointUserName: string
dtsBisLabel: string
dtsInstanceId: string
dtsJobName: string
errorNotice: false
errorPhone: string
instanceClass: string
reserve: string
sourceEndpointDatabaseName: string
sourceEndpointEngineName: string
sourceEndpointInstanceId: string
sourceEndpointInstanceType: string
sourceEndpointIp: string
sourceEndpointOracleSid: string
sourceEndpointOwnerId: string
sourceEndpointPassword: string
sourceEndpointPort: string
sourceEndpointRegion: string
sourceEndpointRole: string
sourceEndpointUserName: string
sourceEndpointVswitchId: string
status: string
structureInitialization: false
synchronizationDirection: string
SynchronizationJob Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SynchronizationJob resource accepts the following input properties:
- Data
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - Data
Synchronization This property is required. Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - Db
List This property is required. string - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - Destination
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - Destination
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - Dts
Instance Id This property is required. Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - Dts
Job Name This property is required. string - The name of synchronization job.
- Source
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - Source
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - Structure
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - Checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- Data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- Dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- Delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - Delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - Delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - Destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- Destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - Destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - Destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- Destination
Endpoint stringPassword - The password of database account.
- Destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- Destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- Destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- Destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- Dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- Error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - Error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - Instance
Class string - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - Reserve string
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- Source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- Source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - Source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - Source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - Source
Endpoint stringPassword - The password of database account.
- Source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- Source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- Source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- Source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- Source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- Status string
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - Synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- Data
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - Data
Synchronization This property is required. Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - Db
List This property is required. string - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - Destination
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - Destination
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - Dts
Instance Id This property is required. Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - Dts
Job Name This property is required. string - The name of synchronization job.
- Source
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - Source
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - Structure
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - Checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- Data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- Dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- Delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - Delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - Delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - Destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- Destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - Destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - Destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- Destination
Endpoint stringPassword - The password of database account.
- Destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- Destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- Destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- Destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- Dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- Error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - Error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - Instance
Class string - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - Reserve string
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- Source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- Source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - Source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - Source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - Source
Endpoint stringPassword - The password of database account.
- Source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- Source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- Source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- Source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- Source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- Status string
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - Synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- data
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - data
Synchronization This property is required. Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - db
List This property is required. String - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - destination
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - destination
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - dts
Instance Id This property is required. Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - dts
Job Name This property is required. String - The name of synchronization job.
- source
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - source
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - structure
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- destination
Endpoint StringPassword - The password of database account.
- destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - instance
Class String - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - reserve String
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - source
Endpoint StringPassword - The password of database account.
- source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- status String
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- data
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - data
Synchronization This property is required. Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - db
List This property is required. string - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - destination
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - destination
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - dts
Instance Id This property is required. Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - dts
Job Name This property is required. string - The name of synchronization job.
- source
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - source
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - structure
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- destination
Endpoint stringPassword - The password of database account.
- destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - instance
Class string - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - reserve string
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - source
Endpoint stringPassword - The password of database account.
- source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- status string
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- data_
initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - data_
synchronization This property is required. Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - db_
list This property is required. str - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - destination_
endpoint_ engine_ name This property is required. Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - destination_
endpoint_ instance_ type This property is required. Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - dts_
instance_ id This property is required. Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - dts_
job_ name This property is required. str - The name of synchronization job.
- source_
endpoint_ engine_ name This property is required. Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - source_
endpoint_ instance_ type This property is required. Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - structure_
initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- data_
check_ configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- dedicated_
cluster_ id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- delay_
notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - delay_
phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - delay_
rule_ time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - destination_
endpoint_ database_ name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- destination_
endpoint_ instance_ id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - destination_
endpoint_ ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - destination_
endpoint_ oracle_ sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- destination_
endpoint_ owner_ id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- destination_
endpoint_ strpassword - The password of database account.
- destination_
endpoint_ port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- destination_
endpoint_ region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- destination_
endpoint_ role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- destination_
endpoint_ user_ name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- dts_
bis_ label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- error_
notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - error_
phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - instance_
class str - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - reserve str
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source_
endpoint_ database_ name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- source_
endpoint_ instance_ id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - source_
endpoint_ ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - source_
endpoint_ oracle_ sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source_
endpoint_ owner_ id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - source_
endpoint_ strpassword - The password of database account.
- source_
endpoint_ port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- source_
endpoint_ region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- source_
endpoint_ role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- source_
endpoint_ user_ name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- source_
endpoint_ vswitch_ id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- status str
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - synchronization_
direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- data
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - data
Synchronization This property is required. Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - db
List This property is required. String - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - destination
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - destination
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - dts
Instance Id This property is required. Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - dts
Job Name This property is required. String - The name of synchronization job.
- source
Endpoint Engine Name This property is required. Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - source
Endpoint Instance Type This property is required. Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - structure
Initialization This property is required. Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- destination
Endpoint StringPassword - The password of database account.
- destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - instance
Class String - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - reserve String
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - source
Endpoint StringPassword - The password of database account.
- source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- status String
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
Outputs
All input properties are implicitly available as output properties. Additionally, the SynchronizationJob resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing SynchronizationJob Resource
Get an existing SynchronizationJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SynchronizationJobState, opts?: CustomResourceOptions): SynchronizationJob
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
checkpoint: Optional[str] = None,
data_check_configure: Optional[str] = None,
data_initialization: Optional[bool] = None,
data_synchronization: Optional[bool] = None,
db_list: Optional[str] = None,
dedicated_cluster_id: Optional[str] = None,
delay_notice: Optional[bool] = None,
delay_phone: Optional[str] = None,
delay_rule_time: Optional[str] = None,
destination_endpoint_database_name: Optional[str] = None,
destination_endpoint_engine_name: Optional[str] = None,
destination_endpoint_instance_id: Optional[str] = None,
destination_endpoint_instance_type: Optional[str] = None,
destination_endpoint_ip: Optional[str] = None,
destination_endpoint_oracle_sid: Optional[str] = None,
destination_endpoint_owner_id: Optional[str] = None,
destination_endpoint_password: Optional[str] = None,
destination_endpoint_port: Optional[str] = None,
destination_endpoint_region: Optional[str] = None,
destination_endpoint_role: Optional[str] = None,
destination_endpoint_user_name: Optional[str] = None,
dts_bis_label: Optional[str] = None,
dts_instance_id: Optional[str] = None,
dts_job_name: Optional[str] = None,
error_notice: Optional[bool] = None,
error_phone: Optional[str] = None,
instance_class: Optional[str] = None,
reserve: Optional[str] = None,
source_endpoint_database_name: Optional[str] = None,
source_endpoint_engine_name: Optional[str] = None,
source_endpoint_instance_id: Optional[str] = None,
source_endpoint_instance_type: Optional[str] = None,
source_endpoint_ip: Optional[str] = None,
source_endpoint_oracle_sid: Optional[str] = None,
source_endpoint_owner_id: Optional[str] = None,
source_endpoint_password: Optional[str] = None,
source_endpoint_port: Optional[str] = None,
source_endpoint_region: Optional[str] = None,
source_endpoint_role: Optional[str] = None,
source_endpoint_user_name: Optional[str] = None,
source_endpoint_vswitch_id: Optional[str] = None,
status: Optional[str] = None,
structure_initialization: Optional[bool] = None,
synchronization_direction: Optional[str] = None) -> SynchronizationJob
func GetSynchronizationJob(ctx *Context, name string, id IDInput, state *SynchronizationJobState, opts ...ResourceOption) (*SynchronizationJob, error)
public static SynchronizationJob Get(string name, Input<string> id, SynchronizationJobState? state, CustomResourceOptions? opts = null)
public static SynchronizationJob get(String name, Output<String> id, SynchronizationJobState state, CustomResourceOptions options)
resources: _: type: alicloud:dts:SynchronizationJob get: id: ${id}
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- Data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- Data
Initialization Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - Data
Synchronization Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - Db
List string - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - Dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- Delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - Delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - Delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - Destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- Destination
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - Destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - Destination
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - Destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - Destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- Destination
Endpoint stringPassword - The password of database account.
- Destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- Destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- Destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- Destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- Dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- Dts
Instance Id Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - Dts
Job stringName - The name of synchronization job.
- Error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - Error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - Instance
Class string - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - Reserve string
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- Source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- Source
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - Source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - Source
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - Source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - Source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - Source
Endpoint stringPassword - The password of database account.
- Source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- Source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- Source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- Source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- Source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- Status string
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - Structure
Initialization Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - Synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- Checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- Data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- Data
Initialization Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - Data
Synchronization Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - Db
List string - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - Dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- Delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - Delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - Delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - Destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- Destination
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - Destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - Destination
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - Destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - Destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- Destination
Endpoint stringPassword - The password of database account.
- Destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- Destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- Destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- Destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- Dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- Dts
Instance Id Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - Dts
Job stringName - The name of synchronization job.
- Error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - Error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - Instance
Class string - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - Reserve string
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- Source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- Source
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - Source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - Source
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - Source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - Source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - Source
Endpoint stringPassword - The password of database account.
- Source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- Source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- Source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- Source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- Source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- Status string
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - Structure
Initialization Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - Synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- data
Initialization Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - data
Synchronization Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - db
List String - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- destination
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - destination
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- destination
Endpoint StringPassword - The password of database account.
- destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- dts
Instance Id Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - dts
Job StringName - The name of synchronization job.
- error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - instance
Class String - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - reserve String
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- source
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - source
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - source
Endpoint StringPassword - The password of database account.
- source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- status String
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - structure
Initialization Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- data
Initialization Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - data
Synchronization Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - db
List string - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- destination
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - destination
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- destination
Endpoint stringPassword - The password of database account.
- destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- dts
Instance Id Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - dts
Job stringName - The name of synchronization job.
- error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - instance
Class string - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - reserve string
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- source
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - source
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - source
Endpoint stringPassword - The password of database account.
- source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- status string
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - structure
Initialization Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- data_
check_ configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- data_
initialization Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - data_
synchronization Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - db_
list str - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - dedicated_
cluster_ id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- delay_
notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - delay_
phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - delay_
rule_ time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - destination_
endpoint_ database_ name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- destination_
endpoint_ engine_ name Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - destination_
endpoint_ instance_ id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - destination_
endpoint_ instance_ type Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - destination_
endpoint_ ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - destination_
endpoint_ oracle_ sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- destination_
endpoint_ owner_ id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- destination_
endpoint_ strpassword - The password of database account.
- destination_
endpoint_ port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- destination_
endpoint_ region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- destination_
endpoint_ role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- destination_
endpoint_ user_ name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- dts_
bis_ label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- dts_
instance_ id Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - dts_
job_ strname - The name of synchronization job.
- error_
notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - error_
phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - instance_
class str - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - reserve str
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source_
endpoint_ database_ name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- source_
endpoint_ engine_ name Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - source_
endpoint_ instance_ id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - source_
endpoint_ instance_ type Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - source_
endpoint_ ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - source_
endpoint_ oracle_ sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source_
endpoint_ owner_ id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - source_
endpoint_ strpassword - The password of database account.
- source_
endpoint_ port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- source_
endpoint_ region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- source_
endpoint_ role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- source_
endpoint_ user_ name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- source_
endpoint_ vswitch_ id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- status str
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - structure_
initialization Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - synchronization_
direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
- checkpoint
Changes to this property will trigger replacement.
- The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
- data
Check Configure Changes to this property will trigger replacement.
- The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
- data
Initialization Changes to this property will trigger replacement.
- Whether to perform full data migration or full data initialization. Valid values:
true
,false
. - data
Synchronization Changes to this property will trigger replacement.
- Whether to perform incremental data migration or synchronization. Valid values:
true
,false
. - db
List String - Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, synchronization or subscription objects. NOTE: From version 1.173.0,
db_list
can be modified. - dedicated
Cluster Id Changes to this property will trigger replacement.
- When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
- delay
Notice Changes to this property will trigger replacement.
- The delay notice. Valid values:
true
,false
. - delay
Phone Changes to this property will trigger replacement.
- The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - delay
Rule Time Changes to this property will trigger replacement.
- The delay rule time. When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load. - destination
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
- destination
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see Supported Databases. When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter
reserve
. For the configuration method, see the description ofreserve
parameters. Valid values:ADS
,ADB30
,AS400
,DATAHUB
,DB2
,GREENPLUM
,KAFKA
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,PostgreSQL
. - destination
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of
destination_endpoint_instance_type
. For example, the value ofdestination_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - destination
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be
OTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to beECS
orEXPRESS
as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see Supported Databases. When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the overview of preparations. Valid values:ADS
,CEN
,DATAHUB
,DG
,ECS
,EXPRESS
,GREENPLUM
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - destination
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
destination_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - destination
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- destination
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
- destination
Endpoint StringPassword - The password of database account.
- destination
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
- destination
Endpoint Region Changes to this property will trigger replacement.
- The region of destination instance. For the target instance region, please refer to the list of supported regions. Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
- destination
Endpoint Role Changes to this property will trigger replacement.
- The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
- destination
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- dts
Bis Label Changes to this property will trigger replacement.
The environment label of the DTS instance. The value is: normal, online.
NOTE: From the status of
NotStarted
toSynchronizing
, the resource goes through thePrechecking
andInitializing
phases. Because of theInitializing
phase takes too long, and once the resource passes to the status ofPrechecking
, it can be considered that the task can be executed normally. Therefore, we treat the status ofInitializing
as an equivalent toSynchronizing
.NOTE: If you want to upgrade the synchronization job specifications by the property
instance_class
, you must also modify the propertyinstance_class
of it's instance to keep them consistent.- dts
Instance Id Changes to this property will trigger replacement.
- The ID of synchronization instance, it must be an ID of
alicloud.dts.SynchronizationInstance
. - dts
Job StringName - The name of synchronization job.
- error
Notice Changes to this property will trigger replacement.
- The error notice. Valid values:
true
,false
. - error
Phone Changes to this property will trigger replacement.
- The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in. - instance
Class String - The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket. - reserve String
- DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint Database Name Changes to this property will trigger replacement.
- The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
- source
Endpoint Engine Name Changes to this property will trigger replacement.
- The type of source database. The default value is
MySQL
. For the correspondence between supported source libraries and target libraries, see Supported Databases. When the database type of the source instance isMONGODB
, you also need to pass in some information in the reserved parameterReserve
, for the configuration method, see the description of Reserve parameters. Valid values:AS400
,DB2
,DMSPOLARDB
,HBASE
,MONGODB
,MSSQL
,MySQL
,ORACLE
,PolarDB
,POLARDBX20
,POLARDB_O
,POSTGRESQL
,TERADATA
. - source
Endpoint Instance Id Changes to this property will trigger replacement.
- The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of
source_endpoint_instance_type
. For example, the value ofsource_endpoint_instance_type
is: **ECS
, then this parameter needs to be passed into the instance ID of ECS. **DG
, then this parameter needs to be passed into the ID of database gateway. **EXPRESS
,CEN
, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. Note: when the value isCEN
, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameterreserve
. - source
Endpoint Instance Type Changes to this property will trigger replacement.
- The type of source instance. If the source instance is a
PolarDB O
engine cluster, the source instance type needs to beOTHER
orEXPRESS
as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see Supported Databases. When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see Preparations Overview. Valid values:CEN
,DG
,DISTRIBUTED_DMSLOGICDB
,ECS
,EXPRESS
,MONGODB
,OTHER
,PolarDB
,POLARDBX20
,RDS
. - source
Endpoint Ip Changes to this property will trigger replacement.
- The IP of source endpoint. When
source_endpoint_instance_type
isOTHER
,EXPRESS
,DG
,CEN
, this parameter is available and must be passed in. - source
Endpoint Oracle Sid Changes to this property will trigger replacement.
- The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint Owner Id Changes to this property will trigger replacement.
- The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the
source_endpoint_role
parameter. - source
Endpoint StringPassword - The password of database account.
- source
Endpoint Port Changes to this property will trigger replacement.
- The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
- source
Endpoint Region Changes to this property will trigger replacement.
- Source instance area, please refer to the list of supported areas for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
- source
Endpoint Role Changes to this property will trigger replacement.
- The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization.
- source
Endpoint User Name Changes to this property will trigger replacement.
- The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see Preparing database accounts for data migration and Preparing database accounts for data synchronization.
- source
Endpoint Vswitch Id Changes to this property will trigger replacement.
- Data Delivery link switch instance id
- status String
- The status of the resource. Valid values:
Synchronizing
,Suspending
. You can stop the task by specifyingSuspending
and start the task by specifyingSynchronizing
. - structure
Initialization Changes to this property will trigger replacement.
- Whether to perform library table structure migration or initialization. Valid values:
true
,false
. - synchronization
Direction Changes to this property will trigger replacement.
- Synchronization direction. Valid values:
Forward
,Reverse
. Only when the propertysync_architecture
of thealicloud.dts.SynchronizationInstance
wasbidirectional
this parameter should be passed, otherwise this parameter should not be specified.
Import
DTS Synchronization Job can be imported using the id, e.g.
$ pulumi import alicloud:dts/synchronizationJob:SynchronizationJob example <id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.