Docs Packages
  1. Pulumi Registry
  2. Alibaba Cloud
  3. API Docs
  4. dts
  5. SynchronizationJob
alicloud logo
Alibaba Cloud v3.37.0, May 15 23

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 in v1.138.0+.

Notice

  1. The expiration time cannot be changed after the work of the annual and monthly subscription suspended;
  2. After the pay-as-you-go type job suspended, your job configuration fee will still be charged;
  3. If the task suspended for more than 6 hours, the task will not start successfully.
  4. Suspending the task will only stop writing to the target library, but will still continue to obtain the incremental log of the source, so that the task can be quickly resumed after the suspension is canceled. Therefore, some resources of the source library, such as bandwidth resources, will continue to be occupied during the period.
  5. Charges will continue during the task suspension period. If you need to stop charging, please release the instance
  6. When a DTS instance suspended for more than 7 days, the instance cannot be resumed, and the status will change from suspended to failed.

Example Usage

Basic Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var defaultSynchronizationInstance = new AliCloud.Dts.SynchronizationInstance("defaultSynchronizationInstance", new()
    {
        PaymentType = "PayAsYouGo",
        SourceEndpointEngineName = "PolarDB",
        SourceEndpointRegion = "cn-hangzhou",
        DestinationEndpointEngineName = "ADB30",
        DestinationEndpointRegion = "cn-hangzhou",
        InstanceClass = "small",
        SyncArchitecture = "oneway",
    });

    var defaultSynchronizationJob = new AliCloud.Dts.SynchronizationJob("defaultSynchronizationJob", new()
    {
        DtsInstanceId = defaultSynchronizationInstance.Id,
        DtsJobName = "tf-testAccCase1",
        SourceEndpointInstanceType = "PolarDB",
        SourceEndpointInstanceId = "pc-xxxxxxxx",
        SourceEndpointEngineName = "PolarDB",
        SourceEndpointRegion = "cn-hangzhou",
        SourceEndpointDatabaseName = "tf-testacc",
        SourceEndpointUserName = "root",
        SourceEndpointPassword = "password",
        DestinationEndpointInstanceType = "ads",
        DestinationEndpointInstanceId = "am-xxxxxxxx",
        DestinationEndpointEngineName = "ADB30",
        DestinationEndpointRegion = "cn-hangzhou",
        DestinationEndpointDatabaseName = "tf-testacc",
        DestinationEndpointUserName = "root",
        DestinationEndpointPassword = "password",
        DbList = "{\"tf-testacc\":{\"name\":\"tf-test\",\"all\":true,\"state\":\"normal\"}}",
        StructureInitialization = true,
        DataInitialization = true,
        DataSynchronization = true,
        Status = "Synchronizing",
    });

});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		defaultSynchronizationInstance, err := dts.NewSynchronizationInstance(ctx, "defaultSynchronizationInstance", &dts.SynchronizationInstanceArgs{
			PaymentType:                   pulumi.String("PayAsYouGo"),
			SourceEndpointEngineName:      pulumi.String("PolarDB"),
			SourceEndpointRegion:          pulumi.String("cn-hangzhou"),
			DestinationEndpointEngineName: pulumi.String("ADB30"),
			DestinationEndpointRegion:     pulumi.String("cn-hangzhou"),
			InstanceClass:                 pulumi.String("small"),
			SyncArchitecture:              pulumi.String("oneway"),
		})
		if err != nil {
			return err
		}
		_, err = dts.NewSynchronizationJob(ctx, "defaultSynchronizationJob", &dts.SynchronizationJobArgs{
			DtsInstanceId:                   defaultSynchronizationInstance.ID(),
			DtsJobName:                      pulumi.String("tf-testAccCase1"),
			SourceEndpointInstanceType:      pulumi.String("PolarDB"),
			SourceEndpointInstanceId:        pulumi.String("pc-xxxxxxxx"),
			SourceEndpointEngineName:        pulumi.String("PolarDB"),
			SourceEndpointRegion:            pulumi.String("cn-hangzhou"),
			SourceEndpointDatabaseName:      pulumi.String("tf-testacc"),
			SourceEndpointUserName:          pulumi.String("root"),
			SourceEndpointPassword:          pulumi.String("password"),
			DestinationEndpointInstanceType: pulumi.String("ads"),
			DestinationEndpointInstanceId:   pulumi.String("am-xxxxxxxx"),
			DestinationEndpointEngineName:   pulumi.String("ADB30"),
			DestinationEndpointRegion:       pulumi.String("cn-hangzhou"),
			DestinationEndpointDatabaseName: pulumi.String("tf-testacc"),
			DestinationEndpointUserName:     pulumi.String("root"),
			DestinationEndpointPassword:     pulumi.String("password"),
			DbList:                          pulumi.String("{\"tf-testacc\":{\"name\":\"tf-test\",\"all\":true,\"state\":\"normal\"}}"),
			StructureInitialization:         pulumi.Bool(true),
			DataInitialization:              pulumi.Bool(true),
			DataSynchronization:             pulumi.Bool(true),
			Status:                          pulumi.String("Synchronizing"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.dts.SynchronizationInstance;
import com.pulumi.alicloud.dts.SynchronizationInstanceArgs;
import com.pulumi.alicloud.dts.SynchronizationJob;
import com.pulumi.alicloud.dts.SynchronizationJobArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var defaultSynchronizationInstance = new SynchronizationInstance("defaultSynchronizationInstance", SynchronizationInstanceArgs.builder()        
            .paymentType("PayAsYouGo")
            .sourceEndpointEngineName("PolarDB")
            .sourceEndpointRegion("cn-hangzhou")
            .destinationEndpointEngineName("ADB30")
            .destinationEndpointRegion("cn-hangzhou")
            .instanceClass("small")
            .syncArchitecture("oneway")
            .build());

        var defaultSynchronizationJob = new SynchronizationJob("defaultSynchronizationJob", SynchronizationJobArgs.builder()        
            .dtsInstanceId(defaultSynchronizationInstance.id())
            .dtsJobName("tf-testAccCase1")
            .sourceEndpointInstanceType("PolarDB")
            .sourceEndpointInstanceId("pc-xxxxxxxx")
            .sourceEndpointEngineName("PolarDB")
            .sourceEndpointRegion("cn-hangzhou")
            .sourceEndpointDatabaseName("tf-testacc")
            .sourceEndpointUserName("root")
            .sourceEndpointPassword("password")
            .destinationEndpointInstanceType("ads")
            .destinationEndpointInstanceId("am-xxxxxxxx")
            .destinationEndpointEngineName("ADB30")
            .destinationEndpointRegion("cn-hangzhou")
            .destinationEndpointDatabaseName("tf-testacc")
            .destinationEndpointUserName("root")
            .destinationEndpointPassword("password")
            .dbList("{\"tf-testacc\":{\"name\":\"tf-test\",\"all\":true,\"state\":\"normal\"}}")
            .structureInitialization("true")
            .dataInitialization("true")
            .dataSynchronization("true")
            .status("Synchronizing")
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

default_synchronization_instance = alicloud.dts.SynchronizationInstance("defaultSynchronizationInstance",
    payment_type="PayAsYouGo",
    source_endpoint_engine_name="PolarDB",
    source_endpoint_region="cn-hangzhou",
    destination_endpoint_engine_name="ADB30",
    destination_endpoint_region="cn-hangzhou",
    instance_class="small",
    sync_architecture="oneway")
default_synchronization_job = alicloud.dts.SynchronizationJob("defaultSynchronizationJob",
    dts_instance_id=default_synchronization_instance.id,
    dts_job_name="tf-testAccCase1",
    source_endpoint_instance_type="PolarDB",
    source_endpoint_instance_id="pc-xxxxxxxx",
    source_endpoint_engine_name="PolarDB",
    source_endpoint_region="cn-hangzhou",
    source_endpoint_database_name="tf-testacc",
    source_endpoint_user_name="root",
    source_endpoint_password="password",
    destination_endpoint_instance_type="ads",
    destination_endpoint_instance_id="am-xxxxxxxx",
    destination_endpoint_engine_name="ADB30",
    destination_endpoint_region="cn-hangzhou",
    destination_endpoint_database_name="tf-testacc",
    destination_endpoint_user_name="root",
    destination_endpoint_password="password",
    db_list="{\"tf-testacc\":{\"name\":\"tf-test\",\"all\":true,\"state\":\"normal\"}}",
    structure_initialization=True,
    data_initialization=True,
    data_synchronization=True,
    status="Synchronizing")

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const defaultSynchronizationInstance = new alicloud.dts.SynchronizationInstance("defaultSynchronizationInstance", {
    paymentType: "PayAsYouGo",
    sourceEndpointEngineName: "PolarDB",
    sourceEndpointRegion: "cn-hangzhou",
    destinationEndpointEngineName: "ADB30",
    destinationEndpointRegion: "cn-hangzhou",
    instanceClass: "small",
    syncArchitecture: "oneway",
});
const defaultSynchronizationJob = new alicloud.dts.SynchronizationJob("defaultSynchronizationJob", {
    dtsInstanceId: defaultSynchronizationInstance.id,
    dtsJobName: "tf-testAccCase1",
    sourceEndpointInstanceType: "PolarDB",
    sourceEndpointInstanceId: "pc-xxxxxxxx",
    sourceEndpointEngineName: "PolarDB",
    sourceEndpointRegion: "cn-hangzhou",
    sourceEndpointDatabaseName: "tf-testacc",
    sourceEndpointUserName: "root",
    sourceEndpointPassword: "password",
    destinationEndpointInstanceType: "ads",
    destinationEndpointInstanceId: "am-xxxxxxxx",
    destinationEndpointEngineName: "ADB30",
    destinationEndpointRegion: "cn-hangzhou",
    destinationEndpointDatabaseName: "tf-testacc",
    destinationEndpointUserName: "root",
    destinationEndpointPassword: "password",
    dbList: "{\"tf-testacc\":{\"name\":\"tf-test\",\"all\":true,\"state\":\"normal\"}}",
    structureInitialization: true,
    dataInitialization: true,
    dataSynchronization: true,
    status: "Synchronizing",
});

resources:
  defaultSynchronizationInstance:
    type: alicloud:dts:SynchronizationInstance
    properties:
      paymentType: PayAsYouGo
      sourceEndpointEngineName: PolarDB
      sourceEndpointRegion: cn-hangzhou
      destinationEndpointEngineName: ADB30
      destinationEndpointRegion: cn-hangzhou
      instanceClass: small
      syncArchitecture: oneway
  defaultSynchronizationJob:
    type: alicloud:dts:SynchronizationJob
    properties:
      dtsInstanceId: ${defaultSynchronizationInstance.id}
      dtsJobName: tf-testAccCase1
      sourceEndpointInstanceType: PolarDB
      sourceEndpointInstanceId: pc-xxxxxxxx
      sourceEndpointEngineName: PolarDB
      sourceEndpointRegion: cn-hangzhou
      sourceEndpointDatabaseName: tf-testacc
      sourceEndpointUserName: root
      sourceEndpointPassword: password
      destinationEndpointInstanceType: ads
      destinationEndpointInstanceId: am-xxxxxxxx
      destinationEndpointEngineName: ADB30
      destinationEndpointRegion: cn-hangzhou
      destinationEndpointDatabaseName: tf-testacc
      destinationEndpointUserName: root
      destinationEndpointPassword: password
      dbList: '{"tf-testacc":{"name":"tf-test","all":true,"state":"normal"}}'
      structureInitialization: 'true'
      dataInitialization: 'true'
      dataSynchronization: 'true'
      status: Synchronizing

Create SynchronizationJob Resource

new SynchronizationJob(name: string, args: SynchronizationJobArgs, opts?: CustomResourceOptions);
@overload
def SynchronizationJob(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       checkpoint: Optional[str] = None,
                       data_initialization: Optional[bool] = None,
                       data_synchronization: Optional[bool] = None,
                       db_list: 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_password: Optional[str] = None,
                       destination_endpoint_port: Optional[str] = None,
                       destination_endpoint_region: Optional[str] = None,
                       destination_endpoint_user_name: 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,
                       status: Optional[str] = None,
                       structure_initialization: Optional[bool] = None,
                       synchronization_direction: Optional[str] = None)
@overload
def SynchronizationJob(resource_name: str,
                       args: SynchronizationJobArgs,
                       opts: Optional[ResourceOptions] = 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.
name string
The unique name of the resource.
args SynchronizationJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args SynchronizationJobArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SynchronizationJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args SynchronizationJobArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The SynchronizationJob resource accepts the following input properties:

DataInitialization bool

Whether to perform full data migration or full data initialization. Valid values: true, false.

DataSynchronization bool

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

DestinationEndpointEngineName string

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

DestinationEndpointInstanceType string

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

DtsInstanceId string

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

DtsJobName string

The name of synchronization job.

SourceEndpointEngineName string

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

SourceEndpointInstanceType string

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

StructureInitialization bool

Whether to perform library table structure migration or initialization. Valid values: true, false.

Checkpoint string

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

DelayNotice bool

The delay notice. Valid values: true, false.

DelayPhone string

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.

DelayRuleTime string

The delay rule time. When delay_notice is set to true, 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.

DestinationEndpointDatabaseName string

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.

DestinationEndpointInstanceId string

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

DestinationEndpointIp string

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

DestinationEndpointOracleSid string

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.

DestinationEndpointPassword string

The password of database account.

DestinationEndpointPort string

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

DestinationEndpointRegion string

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.

DestinationEndpointUserName string

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.

ErrorNotice bool

The error notice. Valid values: true, false.

ErrorPhone string

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.

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

SourceEndpointDatabaseName string

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.

SourceEndpointInstanceId string

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

SourceEndpointIp string

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

SourceEndpointOracleSid string

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.

SourceEndpointOwnerId string

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.

SourceEndpointPassword string

The password of database account.

SourceEndpointPort string

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

SourceEndpointRegion string

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.

SourceEndpointRole string

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.

SourceEndpointUserName string

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.

Status string

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

SynchronizationDirection string

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

DataInitialization bool

Whether to perform full data migration or full data initialization. Valid values: true, false.

DataSynchronization bool

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

DestinationEndpointEngineName string

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

DestinationEndpointInstanceType string

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

DtsInstanceId string

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

DtsJobName string

The name of synchronization job.

SourceEndpointEngineName string

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

SourceEndpointInstanceType string

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

StructureInitialization bool

Whether to perform library table structure migration or initialization. Valid values: true, false.

Checkpoint string

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

DelayNotice bool

The delay notice. Valid values: true, false.

DelayPhone string

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.

DelayRuleTime string

The delay rule time. When delay_notice is set to true, 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.

DestinationEndpointDatabaseName string

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.

DestinationEndpointInstanceId string

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

DestinationEndpointIp string

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

DestinationEndpointOracleSid string

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.

DestinationEndpointPassword string

The password of database account.

DestinationEndpointPort string

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

DestinationEndpointRegion string

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.

DestinationEndpointUserName string

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.

ErrorNotice bool

The error notice. Valid values: true, false.

ErrorPhone string

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.

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

SourceEndpointDatabaseName string

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.

SourceEndpointInstanceId string

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

SourceEndpointIp string

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

SourceEndpointOracleSid string

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.

SourceEndpointOwnerId string

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.

SourceEndpointPassword string

The password of database account.

SourceEndpointPort string

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

SourceEndpointRegion string

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.

SourceEndpointRole string

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.

SourceEndpointUserName string

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.

Status string

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

SynchronizationDirection string

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

dataInitialization Boolean

Whether to perform full data migration or full data initialization. Valid values: true, false.

dataSynchronization Boolean

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

destinationEndpointEngineName String

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

destinationEndpointInstanceType String

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

dtsInstanceId String

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

dtsJobName String

The name of synchronization job.

sourceEndpointEngineName String

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

sourceEndpointInstanceType String

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

structureInitialization Boolean

Whether to perform library table structure migration or initialization. Valid values: true, false.

checkpoint String

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

delayNotice Boolean

The delay notice. Valid values: true, false.

delayPhone String

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.

delayRuleTime String

The delay rule time. When delay_notice is set to true, 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.

destinationEndpointDatabaseName String

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.

destinationEndpointInstanceId String

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

destinationEndpointIp String

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

destinationEndpointOracleSid String

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.

destinationEndpointPassword String

The password of database account.

destinationEndpointPort String

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

destinationEndpointRegion String

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.

destinationEndpointUserName String

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.

errorNotice Boolean

The error notice. Valid values: true, false.

errorPhone String

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.

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

sourceEndpointDatabaseName String

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.

sourceEndpointInstanceId String

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

sourceEndpointIp String

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

sourceEndpointOracleSid String

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.

sourceEndpointOwnerId String

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.

sourceEndpointPassword String

The password of database account.

sourceEndpointPort String

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

sourceEndpointRegion String

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.

sourceEndpointRole String

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.

sourceEndpointUserName String

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.

status String

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

synchronizationDirection String

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

dataInitialization boolean

Whether to perform full data migration or full data initialization. Valid values: true, false.

dataSynchronization boolean

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

destinationEndpointEngineName string

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

destinationEndpointInstanceType string

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

dtsInstanceId string

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

dtsJobName string

The name of synchronization job.

sourceEndpointEngineName string

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

sourceEndpointInstanceType string

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

structureInitialization boolean

Whether to perform library table structure migration or initialization. Valid values: true, false.

checkpoint string

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

delayNotice boolean

The delay notice. Valid values: true, false.

delayPhone string

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.

delayRuleTime string

The delay rule time. When delay_notice is set to true, 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.

destinationEndpointDatabaseName string

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.

destinationEndpointInstanceId string

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

destinationEndpointIp string

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

destinationEndpointOracleSid string

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.

destinationEndpointPassword string

The password of database account.

destinationEndpointPort string

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

destinationEndpointRegion string

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.

destinationEndpointUserName string

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.

errorNotice boolean

The error notice. Valid values: true, false.

errorPhone string

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.

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

sourceEndpointDatabaseName string

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.

sourceEndpointInstanceId string

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

sourceEndpointIp string

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

sourceEndpointOracleSid string

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.

sourceEndpointOwnerId string

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.

sourceEndpointPassword string

The password of database account.

sourceEndpointPort string

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

sourceEndpointRegion string

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.

sourceEndpointRole string

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.

sourceEndpointUserName string

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.

status string

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

synchronizationDirection string

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

data_initialization bool

Whether to perform full data migration or full data initialization. Valid values: true, false.

data_synchronization bool

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.

destination_endpoint_engine_name str

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

destination_endpoint_instance_type str

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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 str

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

dts_job_name str

The name of synchronization job.

source_endpoint_engine_name str

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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 str

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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 bool

Whether to perform library table structure migration or initialization. Valid values: true, false.

checkpoint str

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

delay_notice bool

The delay notice. Valid values: true, false.

delay_phone str

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 str

The delay rule time. When delay_notice is set to true, 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 str

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 str

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

destination_endpoint_ip str

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

destination_endpoint_oracle_sid str

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_password str

The password of database account.

destination_endpoint_port str

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 str

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_user_name str

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.

error_notice bool

The error notice. Valid values: true, false.

error_phone str

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 str

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 str

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

source_endpoint_ip str

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

source_endpoint_oracle_sid str

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 str

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_password str

The password of database account.

source_endpoint_port str

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 str

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 str

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 str

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.

status str

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

synchronization_direction str

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

dataInitialization Boolean

Whether to perform full data migration or full data initialization. Valid values: true, false.

dataSynchronization Boolean

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

destinationEndpointEngineName String

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

destinationEndpointInstanceType String

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

dtsInstanceId String

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

dtsJobName String

The name of synchronization job.

sourceEndpointEngineName String

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

sourceEndpointInstanceType String

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

structureInitialization Boolean

Whether to perform library table structure migration or initialization. Valid values: true, false.

checkpoint String

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

delayNotice Boolean

The delay notice. Valid values: true, false.

delayPhone String

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.

delayRuleTime String

The delay rule time. When delay_notice is set to true, 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.

destinationEndpointDatabaseName String

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.

destinationEndpointInstanceId String

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

destinationEndpointIp String

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

destinationEndpointOracleSid String

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.

destinationEndpointPassword String

The password of database account.

destinationEndpointPort String

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

destinationEndpointRegion String

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.

destinationEndpointUserName String

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.

errorNotice Boolean

The error notice. Valid values: true, false.

errorPhone String

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.

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

sourceEndpointDatabaseName String

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.

sourceEndpointInstanceId String

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

sourceEndpointIp String

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

sourceEndpointOracleSid String

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.

sourceEndpointOwnerId String

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.

sourceEndpointPassword String

The password of database account.

sourceEndpointPort String

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

sourceEndpointRegion String

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.

sourceEndpointRole String

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.

sourceEndpointUserName String

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.

status String

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

synchronizationDirection String

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional 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_initialization: Optional[bool] = None,
        data_synchronization: Optional[bool] = None,
        db_list: 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_password: Optional[str] = None,
        destination_endpoint_port: Optional[str] = None,
        destination_endpoint_region: Optional[str] = None,
        destination_endpoint_user_name: 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,
        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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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.
The following state arguments are supported:
Checkpoint string

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

DataInitialization bool

Whether to perform full data migration or full data initialization. Valid values: true, false.

DataSynchronization bool

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

DelayNotice bool

The delay notice. Valid values: true, false.

DelayPhone string

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.

DelayRuleTime string

The delay rule time. When delay_notice is set to true, 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.

DestinationEndpointDatabaseName string

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.

DestinationEndpointEngineName string

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

DestinationEndpointInstanceId string

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

DestinationEndpointInstanceType string

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

DestinationEndpointIp string

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

DestinationEndpointOracleSid string

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.

DestinationEndpointPassword string

The password of database account.

DestinationEndpointPort string

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

DestinationEndpointRegion string

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.

DestinationEndpointUserName string

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.

DtsInstanceId string

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

DtsJobName string

The name of synchronization job.

ErrorNotice bool

The error notice. Valid values: true, false.

ErrorPhone string

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.

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

SourceEndpointDatabaseName string

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.

SourceEndpointEngineName string

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

SourceEndpointInstanceId string

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

SourceEndpointInstanceType string

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

SourceEndpointIp string

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

SourceEndpointOracleSid string

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.

SourceEndpointOwnerId string

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.

SourceEndpointPassword string

The password of database account.

SourceEndpointPort string

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

SourceEndpointRegion string

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.

SourceEndpointRole string

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.

SourceEndpointUserName string

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.

Status string

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

StructureInitialization bool

Whether to perform library table structure migration or initialization. Valid values: true, false.

SynchronizationDirection string

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

Checkpoint string

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

DataInitialization bool

Whether to perform full data migration or full data initialization. Valid values: true, false.

DataSynchronization bool

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

DelayNotice bool

The delay notice. Valid values: true, false.

DelayPhone string

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.

DelayRuleTime string

The delay rule time. When delay_notice is set to true, 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.

DestinationEndpointDatabaseName string

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.

DestinationEndpointEngineName string

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

DestinationEndpointInstanceId string

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

DestinationEndpointInstanceType string

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

DestinationEndpointIp string

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

DestinationEndpointOracleSid string

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.

DestinationEndpointPassword string

The password of database account.

DestinationEndpointPort string

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

DestinationEndpointRegion string

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.

DestinationEndpointUserName string

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.

DtsInstanceId string

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

DtsJobName string

The name of synchronization job.

ErrorNotice bool

The error notice. Valid values: true, false.

ErrorPhone string

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.

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

SourceEndpointDatabaseName string

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.

SourceEndpointEngineName string

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

SourceEndpointInstanceId string

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

SourceEndpointInstanceType string

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

SourceEndpointIp string

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

SourceEndpointOracleSid string

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.

SourceEndpointOwnerId string

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.

SourceEndpointPassword string

The password of database account.

SourceEndpointPort string

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

SourceEndpointRegion string

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.

SourceEndpointRole string

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.

SourceEndpointUserName string

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.

Status string

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

StructureInitialization bool

Whether to perform library table structure migration or initialization. Valid values: true, false.

SynchronizationDirection string

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

checkpoint String

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

dataInitialization Boolean

Whether to perform full data migration or full data initialization. Valid values: true, false.

dataSynchronization Boolean

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

delayNotice Boolean

The delay notice. Valid values: true, false.

delayPhone String

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.

delayRuleTime String

The delay rule time. When delay_notice is set to true, 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.

destinationEndpointDatabaseName String

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.

destinationEndpointEngineName String

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

destinationEndpointInstanceId String

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

destinationEndpointInstanceType String

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

destinationEndpointIp String

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

destinationEndpointOracleSid String

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.

destinationEndpointPassword String

The password of database account.

destinationEndpointPort String

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

destinationEndpointRegion String

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.

destinationEndpointUserName String

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.

dtsInstanceId String

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

dtsJobName String

The name of synchronization job.

errorNotice Boolean

The error notice. Valid values: true, false.

errorPhone String

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.

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

sourceEndpointDatabaseName String

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.

sourceEndpointEngineName String

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

sourceEndpointInstanceId String

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

sourceEndpointInstanceType String

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

sourceEndpointIp String

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

sourceEndpointOracleSid String

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.

sourceEndpointOwnerId String

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.

sourceEndpointPassword String

The password of database account.

sourceEndpointPort String

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

sourceEndpointRegion String

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.

sourceEndpointRole String

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.

sourceEndpointUserName String

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.

status String

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

structureInitialization Boolean

Whether to perform library table structure migration or initialization. Valid values: true, false.

synchronizationDirection String

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

checkpoint string

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

dataInitialization boolean

Whether to perform full data migration or full data initialization. Valid values: true, false.

dataSynchronization boolean

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

delayNotice boolean

The delay notice. Valid values: true, false.

delayPhone string

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.

delayRuleTime string

The delay rule time. When delay_notice is set to true, 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.

destinationEndpointDatabaseName string

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.

destinationEndpointEngineName string

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

destinationEndpointInstanceId string

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

destinationEndpointInstanceType string

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

destinationEndpointIp string

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

destinationEndpointOracleSid string

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.

destinationEndpointPassword string

The password of database account.

destinationEndpointPort string

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

destinationEndpointRegion string

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.

destinationEndpointUserName string

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.

dtsInstanceId string

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

dtsJobName string

The name of synchronization job.

errorNotice boolean

The error notice. Valid values: true, false.

errorPhone string

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.

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

sourceEndpointDatabaseName string

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.

sourceEndpointEngineName string

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

sourceEndpointInstanceId string

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

sourceEndpointInstanceType string

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

sourceEndpointIp string

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

sourceEndpointOracleSid string

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.

sourceEndpointOwnerId string

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.

sourceEndpointPassword string

The password of database account.

sourceEndpointPort string

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

sourceEndpointRegion string

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.

sourceEndpointRole string

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.

sourceEndpointUserName string

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.

status string

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

structureInitialization boolean

Whether to perform library table structure migration or initialization. Valid values: true, false.

synchronizationDirection string

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

checkpoint str

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

data_initialization bool

Whether to perform full data migration or full data initialization. Valid values: true, false.

data_synchronization bool

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.

delay_notice bool

The delay notice. Valid values: true, false.

delay_phone str

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 str

The delay rule time. When delay_notice is set to true, 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 str

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 str

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

destination_endpoint_instance_id str

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

destination_endpoint_instance_type str

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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 str

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

destination_endpoint_oracle_sid str

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_password str

The password of database account.

destination_endpoint_port str

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 str

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_user_name str

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_instance_id str

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

dts_job_name str

The name of synchronization job.

error_notice bool

The error notice. Valid values: true, false.

error_phone str

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 str

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 str

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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 str

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

source_endpoint_instance_type str

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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 str

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

source_endpoint_oracle_sid str

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 str

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_password str

The password of database account.

source_endpoint_port str

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 str

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 str

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 str

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.

status str

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

structure_initialization bool

Whether to perform library table structure migration or initialization. Valid values: true, false.

synchronization_direction str

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional this parameter should be passed, otherwise this parameter should not be specified.

checkpoint String

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

dataInitialization Boolean

Whether to perform full data migration or full data initialization. Valid values: true, false.

dataSynchronization Boolean

Whether to perform incremental data migration or synchronization. Valid values: true, false.

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

delayNotice Boolean

The delay notice. Valid values: true, false.

delayPhone String

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.

delayRuleTime String

The delay rule time. When delay_notice is set to true, 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.

destinationEndpointDatabaseName String

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.

destinationEndpointEngineName String

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 of reserve parameters. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.

destinationEndpointInstanceId String

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 of destination_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

destinationEndpointInstanceType String

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be OTHER or EXPRESS 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 be ECS or EXPRESS 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.

destinationEndpointIp String

The IP of source endpoint. When destination_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

destinationEndpointOracleSid String

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.

destinationEndpointPassword String

The password of database account.

destinationEndpointPort String

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

destinationEndpointRegion String

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.

destinationEndpointUserName String

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.

dtsInstanceId String

The ID of synchronization instance, it must be an ID of alicloud.dts.SynchronizationInstance.

dtsJobName String

The name of synchronization job.

errorNotice Boolean

The error notice. Valid values: true, false.

errorPhone String

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.

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

sourceEndpointDatabaseName String

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.

sourceEndpointEngineName String

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 is MONGODB, you also need to pass in some information in the reserved parameter Reserve, 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.

sourceEndpointInstanceId String

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 of source_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 is CEN, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter reserve.

sourceEndpointInstanceType String

The type of source instance. If the source instance is a PolarDB O engine cluster, the source instance type needs to be OTHER or EXPRESS 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.

sourceEndpointIp String

The IP of source endpoint. When source_endpoint_instance_type is OTHER, EXPRESS, DG, CEN, this parameter is available and must be passed in.

sourceEndpointOracleSid String

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.

sourceEndpointOwnerId String

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.

sourceEndpointPassword String

The password of database account.

sourceEndpointPort String

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

sourceEndpointRegion String

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.

sourceEndpointRole String

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.

sourceEndpointUserName String

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.

status String

The status of the resource. Valid values: Synchronizing, Suspending. You can stop the task by specifying Suspending and start the task by specifying Synchronizing.

NOTE: From the status of NotStarted to Synchronizing, the resource goes through the Prechecking and Initializing phases. Because of the Initializing phase takes too long, and once the resource passes to the status of Prechecking, it can be considered that the task can be executed normally. Therefore, we treat the status of Initializing as an equivalent to Synchronizing.

NOTE: If you want to upgrade the synchronization job specifications by the property instance_class, you must also modify the property instance_class of it's instance to keep them consistent.

structureInitialization Boolean

Whether to perform library table structure migration or initialization. Valid values: true, false.

synchronizationDirection String

Synchronization direction. Valid values: Forward, Reverse. Only when the property sync_architecture of the alicloud.dts.SynchronizationInstance was bidirectional 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>

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.