Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. dts
  5. SynchronizationJob
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.dts.SynchronizationJob

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a DTS Synchronization Job resource.

    For information about DTS Synchronization Job and how to use it, see What is Synchronization Job.

    NOTE: Available since v1.138.0.

    Create SynchronizationJob Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SynchronizationJob(name: string, args: SynchronizationJobArgs, opts?: CustomResourceOptions);
    @overload
def SynchronizationJob(resource_name: str,
                       args: SynchronizationJobArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def SynchronizationJob(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       destination_endpoint_engine_name: Optional[str] = None,
                       structure_initialization: Optional[bool] = None,
                       data_initialization: Optional[bool] = None,
                       data_synchronization: Optional[bool] = None,
                       db_list: Optional[str] = None,
                       source_endpoint_instance_type: Optional[str] = None,
                       source_endpoint_engine_name: Optional[str] = None,
                       dts_job_name: Optional[str] = None,
                       dts_instance_id: Optional[str] = None,
                       destination_endpoint_instance_type: Optional[str] = None,
                       destination_endpoint_instance_id: Optional[str] = None,
                       reserve: Optional[str] = None,
                       destination_endpoint_database_name: Optional[str] = None,
                       destination_endpoint_ip: Optional[str] = None,
                       destination_endpoint_oracle_sid: Optional[str] = None,
                       destination_endpoint_owner_id: Optional[str] = None,
                       destination_endpoint_password: Optional[str] = None,
                       destination_endpoint_port: Optional[str] = None,
                       destination_endpoint_region: Optional[str] = None,
                       destination_endpoint_role: Optional[str] = None,
                       destination_endpoint_user_name: Optional[str] = None,
                       dts_bis_label: Optional[str] = None,
                       delay_rule_time: Optional[str] = None,
                       delay_phone: Optional[str] = None,
                       error_notice: Optional[bool] = None,
                       error_phone: Optional[str] = None,
                       instance_class: Optional[str] = None,
                       checkpoint: Optional[str] = None,
                       source_endpoint_database_name: Optional[str] = None,
                       delay_notice: Optional[bool] = None,
                       source_endpoint_instance_id: Optional[str] = None,
                       dedicated_cluster_id: Optional[str] = None,
                       source_endpoint_ip: Optional[str] = None,
                       source_endpoint_oracle_sid: Optional[str] = None,
                       source_endpoint_owner_id: Optional[str] = None,
                       source_endpoint_password: Optional[str] = None,
                       source_endpoint_port: Optional[str] = None,
                       source_endpoint_region: Optional[str] = None,
                       source_endpoint_role: Optional[str] = None,
                       source_endpoint_user_name: Optional[str] = None,
                       source_endpoint_vswitch_id: Optional[str] = None,
                       status: Optional[str] = None,
                       data_check_configure: Optional[str] = None,
                       synchronization_direction: Optional[str] = None)
    func NewSynchronizationJob(ctx *Context, name string, args SynchronizationJobArgs, opts ...ResourceOption) (*SynchronizationJob, error)
    public SynchronizationJob(string name, SynchronizationJobArgs args, CustomResourceOptions? opts = null)
    public SynchronizationJob(String name, SynchronizationJobArgs args)
public SynchronizationJob(String name, SynchronizationJobArgs args, CustomResourceOptions options)

    type: alicloud:dts:SynchronizationJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var synchronizationJobResource = new AliCloud.Dts.SynchronizationJob("synchronizationJobResource", new()
{
    DestinationEndpointEngineName = "string",
    StructureInitialization = false,
    DataInitialization = false,
    DataSynchronization = false,
    DbList = "string",
    SourceEndpointInstanceType = "string",
    SourceEndpointEngineName = "string",
    DtsJobName = "string",
    DtsInstanceId = "string",
    DestinationEndpointInstanceType = "string",
    DestinationEndpointInstanceId = "string",
    Reserve = "string",
    DestinationEndpointDatabaseName = "string",
    DestinationEndpointIp = "string",
    DestinationEndpointOracleSid = "string",
    DestinationEndpointOwnerId = "string",
    DestinationEndpointPassword = "string",
    DestinationEndpointPort = "string",
    DestinationEndpointRegion = "string",
    DestinationEndpointRole = "string",
    DestinationEndpointUserName = "string",
    DtsBisLabel = "string",
    DelayRuleTime = "string",
    DelayPhone = "string",
    ErrorNotice = false,
    ErrorPhone = "string",
    InstanceClass = "string",
    Checkpoint = "string",
    SourceEndpointDatabaseName = "string",
    DelayNotice = false,
    SourceEndpointInstanceId = "string",
    DedicatedClusterId = "string",
    SourceEndpointIp = "string",
    SourceEndpointOracleSid = "string",
    SourceEndpointOwnerId = "string",
    SourceEndpointPassword = "string",
    SourceEndpointPort = "string",
    SourceEndpointRegion = "string",
    SourceEndpointRole = "string",
    SourceEndpointUserName = "string",
    SourceEndpointVswitchId = "string",
    Status = "string",
    DataCheckConfigure = "string",
    SynchronizationDirection = "string",
});

    example, err := dts.NewSynchronizationJob(ctx, "synchronizationJobResource", &dts.SynchronizationJobArgs{
	DestinationEndpointEngineName:   pulumi.String("string"),
	StructureInitialization:         pulumi.Bool(false),
	DataInitialization:              pulumi.Bool(false),
	DataSynchronization:             pulumi.Bool(false),
	DbList:                          pulumi.String("string"),
	SourceEndpointInstanceType:      pulumi.String("string"),
	SourceEndpointEngineName:        pulumi.String("string"),
	DtsJobName:                      pulumi.String("string"),
	DtsInstanceId:                   pulumi.String("string"),
	DestinationEndpointInstanceType: pulumi.String("string"),
	DestinationEndpointInstanceId:   pulumi.String("string"),
	Reserve:                         pulumi.String("string"),
	DestinationEndpointDatabaseName: pulumi.String("string"),
	DestinationEndpointIp:           pulumi.String("string"),
	DestinationEndpointOracleSid:    pulumi.String("string"),
	DestinationEndpointOwnerId:      pulumi.String("string"),
	DestinationEndpointPassword:     pulumi.String("string"),
	DestinationEndpointPort:         pulumi.String("string"),
	DestinationEndpointRegion:       pulumi.String("string"),
	DestinationEndpointRole:         pulumi.String("string"),
	DestinationEndpointUserName:     pulumi.String("string"),
	DtsBisLabel:                     pulumi.String("string"),
	DelayRuleTime:                   pulumi.String("string"),
	DelayPhone:                      pulumi.String("string"),
	ErrorNotice:                     pulumi.Bool(false),
	ErrorPhone:                      pulumi.String("string"),
	InstanceClass:                   pulumi.String("string"),
	Checkpoint:                      pulumi.String("string"),
	SourceEndpointDatabaseName:      pulumi.String("string"),
	DelayNotice:                     pulumi.Bool(false),
	SourceEndpointInstanceId:        pulumi.String("string"),
	DedicatedClusterId:              pulumi.String("string"),
	SourceEndpointIp:                pulumi.String("string"),
	SourceEndpointOracleSid:         pulumi.String("string"),
	SourceEndpointOwnerId:           pulumi.String("string"),
	SourceEndpointPassword:          pulumi.String("string"),
	SourceEndpointPort:              pulumi.String("string"),
	SourceEndpointRegion:            pulumi.String("string"),
	SourceEndpointRole:              pulumi.String("string"),
	SourceEndpointUserName:          pulumi.String("string"),
	SourceEndpointVswitchId:         pulumi.String("string"),
	Status:                          pulumi.String("string"),
	DataCheckConfigure:              pulumi.String("string"),
	SynchronizationDirection:        pulumi.String("string"),
})

    var synchronizationJobResource = new SynchronizationJob("synchronizationJobResource", SynchronizationJobArgs.builder()
    .destinationEndpointEngineName("string")
    .structureInitialization(false)
    .dataInitialization(false)
    .dataSynchronization(false)
    .dbList("string")
    .sourceEndpointInstanceType("string")
    .sourceEndpointEngineName("string")
    .dtsJobName("string")
    .dtsInstanceId("string")
    .destinationEndpointInstanceType("string")
    .destinationEndpointInstanceId("string")
    .reserve("string")
    .destinationEndpointDatabaseName("string")
    .destinationEndpointIp("string")
    .destinationEndpointOracleSid("string")
    .destinationEndpointOwnerId("string")
    .destinationEndpointPassword("string")
    .destinationEndpointPort("string")
    .destinationEndpointRegion("string")
    .destinationEndpointRole("string")
    .destinationEndpointUserName("string")
    .dtsBisLabel("string")
    .delayRuleTime("string")
    .delayPhone("string")
    .errorNotice(false)
    .errorPhone("string")
    .instanceClass("string")
    .checkpoint("string")
    .sourceEndpointDatabaseName("string")
    .delayNotice(false)
    .sourceEndpointInstanceId("string")
    .dedicatedClusterId("string")
    .sourceEndpointIp("string")
    .sourceEndpointOracleSid("string")
    .sourceEndpointOwnerId("string")
    .sourceEndpointPassword("string")
    .sourceEndpointPort("string")
    .sourceEndpointRegion("string")
    .sourceEndpointRole("string")
    .sourceEndpointUserName("string")
    .sourceEndpointVswitchId("string")
    .status("string")
    .dataCheckConfigure("string")
    .synchronizationDirection("string")
    .build());

    synchronization_job_resource = alicloud.dts.SynchronizationJob("synchronizationJobResource",
    destination_endpoint_engine_name="string",
    structure_initialization=False,
    data_initialization=False,
    data_synchronization=False,
    db_list="string",
    source_endpoint_instance_type="string",
    source_endpoint_engine_name="string",
    dts_job_name="string",
    dts_instance_id="string",
    destination_endpoint_instance_type="string",
    destination_endpoint_instance_id="string",
    reserve="string",
    destination_endpoint_database_name="string",
    destination_endpoint_ip="string",
    destination_endpoint_oracle_sid="string",
    destination_endpoint_owner_id="string",
    destination_endpoint_password="string",
    destination_endpoint_port="string",
    destination_endpoint_region="string",
    destination_endpoint_role="string",
    destination_endpoint_user_name="string",
    dts_bis_label="string",
    delay_rule_time="string",
    delay_phone="string",
    error_notice=False,
    error_phone="string",
    instance_class="string",
    checkpoint="string",
    source_endpoint_database_name="string",
    delay_notice=False,
    source_endpoint_instance_id="string",
    dedicated_cluster_id="string",
    source_endpoint_ip="string",
    source_endpoint_oracle_sid="string",
    source_endpoint_owner_id="string",
    source_endpoint_password="string",
    source_endpoint_port="string",
    source_endpoint_region="string",
    source_endpoint_role="string",
    source_endpoint_user_name="string",
    source_endpoint_vswitch_id="string",
    status="string",
    data_check_configure="string",
    synchronization_direction="string")

    const synchronizationJobResource = new alicloud.dts.SynchronizationJob("synchronizationJobResource", {
    destinationEndpointEngineName: "string",
    structureInitialization: false,
    dataInitialization: false,
    dataSynchronization: false,
    dbList: "string",
    sourceEndpointInstanceType: "string",
    sourceEndpointEngineName: "string",
    dtsJobName: "string",
    dtsInstanceId: "string",
    destinationEndpointInstanceType: "string",
    destinationEndpointInstanceId: "string",
    reserve: "string",
    destinationEndpointDatabaseName: "string",
    destinationEndpointIp: "string",
    destinationEndpointOracleSid: "string",
    destinationEndpointOwnerId: "string",
    destinationEndpointPassword: "string",
    destinationEndpointPort: "string",
    destinationEndpointRegion: "string",
    destinationEndpointRole: "string",
    destinationEndpointUserName: "string",
    dtsBisLabel: "string",
    delayRuleTime: "string",
    delayPhone: "string",
    errorNotice: false,
    errorPhone: "string",
    instanceClass: "string",
    checkpoint: "string",
    sourceEndpointDatabaseName: "string",
    delayNotice: false,
    sourceEndpointInstanceId: "string",
    dedicatedClusterId: "string",
    sourceEndpointIp: "string",
    sourceEndpointOracleSid: "string",
    sourceEndpointOwnerId: "string",
    sourceEndpointPassword: "string",
    sourceEndpointPort: "string",
    sourceEndpointRegion: "string",
    sourceEndpointRole: "string",
    sourceEndpointUserName: "string",
    sourceEndpointVswitchId: "string",
    status: "string",
    dataCheckConfigure: "string",
    synchronizationDirection: "string",
});

    type: alicloud:dts:SynchronizationJob
properties:
    checkpoint: string
    dataCheckConfigure: string
    dataInitialization: false
    dataSynchronization: false
    dbList: string
    dedicatedClusterId: string
    delayNotice: false
    delayPhone: string
    delayRuleTime: string
    destinationEndpointDatabaseName: string
    destinationEndpointEngineName: string
    destinationEndpointInstanceId: string
    destinationEndpointInstanceType: string
    destinationEndpointIp: string
    destinationEndpointOracleSid: string
    destinationEndpointOwnerId: string
    destinationEndpointPassword: string
    destinationEndpointPort: string
    destinationEndpointRegion: string
    destinationEndpointRole: string
    destinationEndpointUserName: string
    dtsBisLabel: string
    dtsInstanceId: string
    dtsJobName: string
    errorNotice: false
    errorPhone: string
    instanceClass: string
    reserve: string
    sourceEndpointDatabaseName: string
    sourceEndpointEngineName: string
    sourceEndpointInstanceId: string
    sourceEndpointInstanceType: string
    sourceEndpointIp: string
    sourceEndpointOracleSid: string
    sourceEndpointOwnerId: string
    sourceEndpointPassword: string
    sourceEndpointPort: string
    sourceEndpointRegion: string
    sourceEndpointRole: string
    sourceEndpointUserName: string
    sourceEndpointVswitchId: string
    status: string
    structureInitialization: false
    synchronizationDirection: string

    SynchronizationJob Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    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.
    DataCheckConfigure string
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    DedicatedClusterId string
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    DestinationEndpointOwnerId string
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    DestinationEndpointRole string
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    DtsBisLabel string

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    SourceEndpointVswitchId string
    Data Delivery link switch instance id
    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.
    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.
    DataCheckConfigure string
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    DedicatedClusterId string
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    DestinationEndpointOwnerId string
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    DestinationEndpointRole string
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    DtsBisLabel string

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    SourceEndpointVswitchId string
    Data Delivery link switch instance id
    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.
    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.
    dataCheckConfigure String
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    dedicatedClusterId String
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    destinationEndpointOwnerId String
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    destinationEndpointRole String
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    dtsBisLabel String

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    sourceEndpointVswitchId String
    Data Delivery link switch instance id
    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.
    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.
    dataCheckConfigure string
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    dedicatedClusterId string
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    destinationEndpointOwnerId string
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    destinationEndpointRole string
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    dtsBisLabel string

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    sourceEndpointVswitchId string
    Data Delivery link switch instance id
    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.
    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.
    data_check_configure str
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    dedicated_cluster_id str
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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_owner_id str
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    destination_endpoint_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_role str
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    destination_endpoint_user_name 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_bis_label str

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    source_endpoint_vswitch_id str
    Data Delivery link switch instance id
    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.
    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.
    dataCheckConfigure String
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    dedicatedClusterId String
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    destinationEndpointOwnerId String
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    destinationEndpointRole String
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    dtsBisLabel String

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    sourceEndpointVswitchId String
    Data Delivery link switch instance id
    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.
    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_check_configure: Optional[str] = None,
        data_initialization: Optional[bool] = None,
        data_synchronization: Optional[bool] = None,
        db_list: Optional[str] = None,
        dedicated_cluster_id: Optional[str] = None,
        delay_notice: Optional[bool] = None,
        delay_phone: Optional[str] = None,
        delay_rule_time: Optional[str] = None,
        destination_endpoint_database_name: Optional[str] = None,
        destination_endpoint_engine_name: Optional[str] = None,
        destination_endpoint_instance_id: Optional[str] = None,
        destination_endpoint_instance_type: Optional[str] = None,
        destination_endpoint_ip: Optional[str] = None,
        destination_endpoint_oracle_sid: Optional[str] = None,
        destination_endpoint_owner_id: Optional[str] = None,
        destination_endpoint_password: Optional[str] = None,
        destination_endpoint_port: Optional[str] = None,
        destination_endpoint_region: Optional[str] = None,
        destination_endpoint_role: Optional[str] = None,
        destination_endpoint_user_name: Optional[str] = None,
        dts_bis_label: Optional[str] = None,
        dts_instance_id: Optional[str] = None,
        dts_job_name: Optional[str] = None,
        error_notice: Optional[bool] = None,
        error_phone: Optional[str] = None,
        instance_class: Optional[str] = None,
        reserve: Optional[str] = None,
        source_endpoint_database_name: Optional[str] = None,
        source_endpoint_engine_name: Optional[str] = None,
        source_endpoint_instance_id: Optional[str] = None,
        source_endpoint_instance_type: Optional[str] = None,
        source_endpoint_ip: Optional[str] = None,
        source_endpoint_oracle_sid: Optional[str] = None,
        source_endpoint_owner_id: Optional[str] = None,
        source_endpoint_password: Optional[str] = None,
        source_endpoint_port: Optional[str] = None,
        source_endpoint_region: Optional[str] = None,
        source_endpoint_role: Optional[str] = None,
        source_endpoint_user_name: Optional[str] = None,
        source_endpoint_vswitch_id: Optional[str] = None,
        status: Optional[str] = None,
        structure_initialization: Optional[bool] = None,
        synchronization_direction: Optional[str] = None) -> SynchronizationJob
    func GetSynchronizationJob(ctx *Context, name string, id IDInput, state *SynchronizationJobState, opts ...ResourceOption) (*SynchronizationJob, error)
    public static SynchronizationJob Get(string name, Input<string> id, SynchronizationJobState? state, CustomResourceOptions? opts = null)
    public static SynchronizationJob get(String name, Output<String> id, SynchronizationJobState state, CustomResourceOptions options)
    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.
    DataCheckConfigure string
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    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.
    DedicatedClusterId string
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    DestinationEndpointOwnerId string
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    DestinationEndpointRole string
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    DtsBisLabel string

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    SourceEndpointVswitchId string
    Data Delivery link switch instance id
    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.
    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.
    DataCheckConfigure string
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    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.
    DedicatedClusterId string
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    DestinationEndpointOwnerId string
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    DestinationEndpointRole string
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    DtsBisLabel string

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    SourceEndpointVswitchId string
    Data Delivery link switch instance id
    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.
    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.
    dataCheckConfigure String
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    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.
    dedicatedClusterId String
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    destinationEndpointOwnerId String
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    destinationEndpointRole String
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    dtsBisLabel String

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    sourceEndpointVswitchId String
    Data Delivery link switch instance id
    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.
    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.
    dataCheckConfigure string
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    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.
    dedicatedClusterId string
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    destinationEndpointOwnerId string
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    destinationEndpointRole string
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    dtsBisLabel string

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    sourceEndpointVswitchId string
    Data Delivery link switch instance id
    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.
    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_check_configure str
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    data_initialization 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.
    dedicated_cluster_id str
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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_owner_id str
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    destination_endpoint_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_role str
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    destination_endpoint_user_name 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_bis_label str

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    source_endpoint_vswitch_id str
    Data Delivery link switch instance id
    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.
    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.
    dataCheckConfigure String
    The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description datacheckconfigure-parameter.
    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.
    dedicatedClusterId String
    When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
    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.
    destinationEndpointOwnerId String
    The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the destinationendpointrle parameter.
    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.
    destinationEndpointRole String
    The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
    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.
    dtsBisLabel String

    The environment label of the DTS instance. The value is: normal, online.

    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.

    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.
    sourceEndpointVswitchId String
    Data Delivery link switch instance id
    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.
    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>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-alicloud