Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. dts
  5. Instance
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.dts.Instance

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Provides a Dts Instance resource.

For information about Dts Instance and how to use it, see What is Instance.

NOTE: Available since v1.198.0.

Example Usage

Basic Usage

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

const _default = alicloud.resourcemanager.getResourceGroups({
    status: "OK",
});
const defaultGetRegions = alicloud.getRegions({
    current: true,
});
const defaultInstance = new alicloud.dts.Instance("default", {
    type: "sync",
    resourceGroupId: _default.then(_default => _default.ids?.[0]),
    paymentType: "Subscription",
    instanceClass: "large",
    sourceEndpointEngineName: "MySQL",
    sourceRegion: defaultGetRegions.then(defaultGetRegions => defaultGetRegions.regions?.[0]?.id),
    destinationEndpointEngineName: "MySQL",
    destinationRegion: defaultGetRegions.then(defaultGetRegions => defaultGetRegions.regions?.[0]?.id),
});
Copy
import pulumi
import pulumi_alicloud as alicloud

default = alicloud.resourcemanager.get_resource_groups(status="OK")
default_get_regions = alicloud.get_regions(current=True)
default_instance = alicloud.dts.Instance("default",
    type="sync",
    resource_group_id=default.ids[0],
    payment_type="Subscription",
    instance_class="large",
    source_endpoint_engine_name="MySQL",
    source_region=default_get_regions.regions[0].id,
    destination_endpoint_engine_name="MySQL",
    destination_region=default_get_regions.regions[0].id)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{
			Status: pulumi.StringRef("OK"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetRegions, err := alicloud.GetRegions(ctx, &alicloud.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = dts.NewInstance(ctx, "default", &dts.InstanceArgs{
			Type:                          pulumi.String("sync"),
			ResourceGroupId:               pulumi.String(_default.Ids[0]),
			PaymentType:                   pulumi.String("Subscription"),
			InstanceClass:                 pulumi.String("large"),
			SourceEndpointEngineName:      pulumi.String("MySQL"),
			SourceRegion:                  pulumi.String(defaultGetRegions.Regions[0].Id),
			DestinationEndpointEngineName: pulumi.String("MySQL"),
			DestinationRegion:             pulumi.String(defaultGetRegions.Regions[0].Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke(new()
    {
        Status = "OK",
    });

    var defaultGetRegions = AliCloud.GetRegions.Invoke(new()
    {
        Current = true,
    });

    var defaultInstance = new AliCloud.Dts.Instance("default", new()
    {
        Type = "sync",
        ResourceGroupId = @default.Apply(@default => @default.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[0])),
        PaymentType = "Subscription",
        InstanceClass = "large",
        SourceEndpointEngineName = "MySQL",
        SourceRegion = defaultGetRegions.Apply(getRegionsResult => getRegionsResult.Regions[0]?.Id),
        DestinationEndpointEngineName = "MySQL",
        DestinationRegion = defaultGetRegions.Apply(getRegionsResult => getRegionsResult.Regions[0]?.Id),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetRegionsArgs;
import com.pulumi.alicloud.dts.Instance;
import com.pulumi.alicloud.dts.InstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var default = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
            .status("OK")
            .build());

        final var defaultGetRegions = AlicloudFunctions.getRegions(GetRegionsArgs.builder()
            .current(true)
            .build());

        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .type("sync")
            .resourceGroupId(default_.ids()[0])
            .paymentType("Subscription")
            .instanceClass("large")
            .sourceEndpointEngineName("MySQL")
            .sourceRegion(defaultGetRegions.applyValue(getRegionsResult -> getRegionsResult.regions()[0].id()))
            .destinationEndpointEngineName("MySQL")
            .destinationRegion(defaultGetRegions.applyValue(getRegionsResult -> getRegionsResult.regions()[0].id()))
            .build());

    }
}
Copy
resources:
  defaultInstance:
    type: alicloud:dts:Instance
    name: default
    properties:
      type: sync
      resourceGroupId: ${default.ids[0]}
      paymentType: Subscription
      instanceClass: large
      sourceEndpointEngineName: MySQL
      sourceRegion: ${defaultGetRegions.regions[0].id}
      destinationEndpointEngineName: MySQL
      destinationRegion: ${defaultGetRegions.regions[0].id}
variables:
  default:
    fn::invoke:
      function: alicloud:resourcemanager:getResourceGroups
      arguments:
        status: OK
  defaultGetRegions:
    fn::invoke:
      function: alicloud:getRegions
      arguments:
        current: true
Copy

Create Instance Resource

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

Constructor syntax

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             auto_pay: Optional[bool] = None,
             auto_start: Optional[bool] = None,
             compute_unit: Optional[int] = None,
             database_count: Optional[int] = None,
             destination_endpoint_engine_name: Optional[str] = None,
             destination_region: Optional[str] = None,
             du: Optional[int] = None,
             fee_type: Optional[str] = None,
             instance_class: Optional[str] = None,
             job_id: Optional[str] = None,
             payment_type: Optional[str] = None,
             period: Optional[str] = None,
             resource_group_id: Optional[str] = None,
             source_endpoint_engine_name: Optional[str] = None,
             source_region: Optional[str] = None,
             sync_architecture: Optional[str] = None,
             synchronization_direction: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             type: Optional[str] = None,
             used_time: Optional[int] = None)
func NewInstance(ctx *Context, name string, args *InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs? args = null, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InstanceArgs
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 exampleinstanceResourceResourceFromDtsinstance = new AliCloud.Dts.Instance("exampleinstanceResourceResourceFromDtsinstance", new()
{
    AutoPay = false,
    AutoStart = false,
    ComputeUnit = 0,
    DatabaseCount = 0,
    DestinationEndpointEngineName = "string",
    DestinationRegion = "string",
    Du = 0,
    FeeType = "string",
    InstanceClass = "string",
    JobId = "string",
    PaymentType = "string",
    Period = "string",
    ResourceGroupId = "string",
    SourceEndpointEngineName = "string",
    SourceRegion = "string",
    SyncArchitecture = "string",
    SynchronizationDirection = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Type = "string",
    UsedTime = 0,
});
Copy
example, err := dts.NewInstance(ctx, "exampleinstanceResourceResourceFromDtsinstance", &dts.InstanceArgs{
	AutoPay:                       pulumi.Bool(false),
	AutoStart:                     pulumi.Bool(false),
	ComputeUnit:                   pulumi.Int(0),
	DatabaseCount:                 pulumi.Int(0),
	DestinationEndpointEngineName: pulumi.String("string"),
	DestinationRegion:             pulumi.String("string"),
	Du:                            pulumi.Int(0),
	FeeType:                       pulumi.String("string"),
	InstanceClass:                 pulumi.String("string"),
	JobId:                         pulumi.String("string"),
	PaymentType:                   pulumi.String("string"),
	Period:                        pulumi.String("string"),
	ResourceGroupId:               pulumi.String("string"),
	SourceEndpointEngineName:      pulumi.String("string"),
	SourceRegion:                  pulumi.String("string"),
	SyncArchitecture:              pulumi.String("string"),
	SynchronizationDirection:      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Type:     pulumi.String("string"),
	UsedTime: pulumi.Int(0),
})
Copy
var exampleinstanceResourceResourceFromDtsinstance = new Instance("exampleinstanceResourceResourceFromDtsinstance", InstanceArgs.builder()
    .autoPay(false)
    .autoStart(false)
    .computeUnit(0)
    .databaseCount(0)
    .destinationEndpointEngineName("string")
    .destinationRegion("string")
    .du(0)
    .feeType("string")
    .instanceClass("string")
    .jobId("string")
    .paymentType("string")
    .period("string")
    .resourceGroupId("string")
    .sourceEndpointEngineName("string")
    .sourceRegion("string")
    .syncArchitecture("string")
    .synchronizationDirection("string")
    .tags(Map.of("string", "string"))
    .type("string")
    .usedTime(0)
    .build());
Copy
exampleinstance_resource_resource_from_dtsinstance = alicloud.dts.Instance("exampleinstanceResourceResourceFromDtsinstance",
    auto_pay=False,
    auto_start=False,
    compute_unit=0,
    database_count=0,
    destination_endpoint_engine_name="string",
    destination_region="string",
    du=0,
    fee_type="string",
    instance_class="string",
    job_id="string",
    payment_type="string",
    period="string",
    resource_group_id="string",
    source_endpoint_engine_name="string",
    source_region="string",
    sync_architecture="string",
    synchronization_direction="string",
    tags={
        "string": "string",
    },
    type="string",
    used_time=0)
Copy
const exampleinstanceResourceResourceFromDtsinstance = new alicloud.dts.Instance("exampleinstanceResourceResourceFromDtsinstance", {
    autoPay: false,
    autoStart: false,
    computeUnit: 0,
    databaseCount: 0,
    destinationEndpointEngineName: "string",
    destinationRegion: "string",
    du: 0,
    feeType: "string",
    instanceClass: "string",
    jobId: "string",
    paymentType: "string",
    period: "string",
    resourceGroupId: "string",
    sourceEndpointEngineName: "string",
    sourceRegion: "string",
    syncArchitecture: "string",
    synchronizationDirection: "string",
    tags: {
        string: "string",
    },
    type: "string",
    usedTime: 0,
});
Copy
type: alicloud:dts:Instance
properties:
    autoPay: false
    autoStart: false
    computeUnit: 0
    databaseCount: 0
    destinationEndpointEngineName: string
    destinationRegion: string
    du: 0
    feeType: string
    instanceClass: string
    jobId: string
    paymentType: string
    period: string
    resourceGroupId: string
    sourceEndpointEngineName: string
    sourceRegion: string
    syncArchitecture: string
    synchronizationDirection: string
    tags:
        string: string
    type: string
    usedTime: 0
Copy

Instance Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Instance resource accepts the following input properties:

AutoPay bool
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
AutoStart bool
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
ComputeUnit int
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
DatabaseCount int
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
DestinationEndpointEngineName Changes to this property will trigger replacement. string
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
DestinationRegion Changes to this property will trigger replacement. string
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
Du int
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
FeeType string
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
InstanceClass Changes to this property will trigger replacement. string
The type of the migration or synchronization instance.

JobId string
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
PaymentType Changes to this property will trigger replacement. string
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
Period string
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
ResourceGroupId string
Resource Group ID.
SourceEndpointEngineName Changes to this property will trigger replacement. string
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
SourceRegion Changes to this property will trigger replacement. string
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
SyncArchitecture string
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
SynchronizationDirection string
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
Tags Dictionary<string, string>
The tag value corresponding to the tag key.See the following Block Tags.
Type Changes to this property will trigger replacement. string
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
UsedTime int
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
AutoPay bool
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
AutoStart bool
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
ComputeUnit int
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
DatabaseCount int
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
DestinationEndpointEngineName Changes to this property will trigger replacement. string
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
DestinationRegion Changes to this property will trigger replacement. string
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
Du int
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
FeeType string
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
InstanceClass Changes to this property will trigger replacement. string
The type of the migration or synchronization instance.

JobId string
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
PaymentType Changes to this property will trigger replacement. string
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
Period string
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
ResourceGroupId string
Resource Group ID.
SourceEndpointEngineName Changes to this property will trigger replacement. string
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
SourceRegion Changes to this property will trigger replacement. string
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
SyncArchitecture string
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
SynchronizationDirection string
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
Tags map[string]string
The tag value corresponding to the tag key.See the following Block Tags.
Type Changes to this property will trigger replacement. string
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
UsedTime int
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
autoPay Boolean
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
autoStart Boolean
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
computeUnit Integer
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
databaseCount Integer
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
destinationEndpointEngineName Changes to this property will trigger replacement. String
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
destinationRegion Changes to this property will trigger replacement. String
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
du Integer
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
feeType String
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
instanceClass Changes to this property will trigger replacement. String
The type of the migration or synchronization instance.

jobId String
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
paymentType Changes to this property will trigger replacement. String
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
period String
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
resourceGroupId String
Resource Group ID.
sourceEndpointEngineName Changes to this property will trigger replacement. String
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
sourceRegion Changes to this property will trigger replacement. String
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
syncArchitecture String
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
synchronizationDirection String
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
tags Map<String,String>
The tag value corresponding to the tag key.See the following Block Tags.
type Changes to this property will trigger replacement. String
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
usedTime Integer
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
autoPay boolean
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
autoStart boolean
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
computeUnit number
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
databaseCount number
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
destinationEndpointEngineName Changes to this property will trigger replacement. string
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
destinationRegion Changes to this property will trigger replacement. string
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
du number
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
feeType string
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
instanceClass Changes to this property will trigger replacement. string
The type of the migration or synchronization instance.

jobId string
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
paymentType Changes to this property will trigger replacement. string
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
period string
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
resourceGroupId string
Resource Group ID.
sourceEndpointEngineName Changes to this property will trigger replacement. string
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
sourceRegion Changes to this property will trigger replacement. string
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
syncArchitecture string
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
synchronizationDirection string
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
tags {[key: string]: string}
The tag value corresponding to the tag key.See the following Block Tags.
type Changes to this property will trigger replacement. string
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
usedTime number
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
auto_pay bool
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
auto_start bool
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
compute_unit int
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
database_count int
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
destination_endpoint_engine_name Changes to this property will trigger replacement. str
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
destination_region Changes to this property will trigger replacement. str
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
du int
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
fee_type str
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
instance_class Changes to this property will trigger replacement. str
The type of the migration or synchronization instance.

job_id str
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
payment_type Changes to this property will trigger replacement. str
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
period str
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
resource_group_id str
Resource Group ID.
source_endpoint_engine_name Changes to this property will trigger replacement. str
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
source_region Changes to this property will trigger replacement. str
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
sync_architecture str
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
synchronization_direction str
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
tags Mapping[str, str]
The tag value corresponding to the tag key.See the following Block Tags.
type Changes to this property will trigger replacement. str
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
used_time int
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
autoPay Boolean
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
autoStart Boolean
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
computeUnit Number
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
databaseCount Number
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
destinationEndpointEngineName Changes to this property will trigger replacement. String
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
destinationRegion Changes to this property will trigger replacement. String
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
du Number
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
feeType String
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
instanceClass Changes to this property will trigger replacement. String
The type of the migration or synchronization instance.

jobId String
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
paymentType Changes to this property will trigger replacement. String
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
period String
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
resourceGroupId String
Resource Group ID.
sourceEndpointEngineName Changes to this property will trigger replacement. String
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
sourceRegion Changes to this property will trigger replacement. String
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
syncArchitecture String
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
synchronizationDirection String
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
tags Map<String>
The tag value corresponding to the tag key.See the following Block Tags.
type Changes to this property will trigger replacement. String
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
usedTime Number
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

CreateTime string
Instance creation time
DtsInstanceId string
The ID of the subscription instance.
Id string
The provider-assigned unique ID for this managed resource.
InstanceName string
The name of Dts instance.
Status string
Instance status.
CreateTime string
Instance creation time
DtsInstanceId string
The ID of the subscription instance.
Id string
The provider-assigned unique ID for this managed resource.
InstanceName string
The name of Dts instance.
Status string
Instance status.
createTime String
Instance creation time
dtsInstanceId String
The ID of the subscription instance.
id String
The provider-assigned unique ID for this managed resource.
instanceName String
The name of Dts instance.
status String
Instance status.
createTime string
Instance creation time
dtsInstanceId string
The ID of the subscription instance.
id string
The provider-assigned unique ID for this managed resource.
instanceName string
The name of Dts instance.
status string
Instance status.
create_time str
Instance creation time
dts_instance_id str
The ID of the subscription instance.
id str
The provider-assigned unique ID for this managed resource.
instance_name str
The name of Dts instance.
status str
Instance status.
createTime String
Instance creation time
dtsInstanceId String
The ID of the subscription instance.
id String
The provider-assigned unique ID for this managed resource.
instanceName String
The name of Dts instance.
status String
Instance status.

Look up Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_pay: Optional[bool] = None,
        auto_start: Optional[bool] = None,
        compute_unit: Optional[int] = None,
        create_time: Optional[str] = None,
        database_count: Optional[int] = None,
        destination_endpoint_engine_name: Optional[str] = None,
        destination_region: Optional[str] = None,
        dts_instance_id: Optional[str] = None,
        du: Optional[int] = None,
        fee_type: Optional[str] = None,
        instance_class: Optional[str] = None,
        instance_name: Optional[str] = None,
        job_id: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        source_endpoint_engine_name: Optional[str] = None,
        source_region: Optional[str] = None,
        status: Optional[str] = None,
        sync_architecture: Optional[str] = None,
        synchronization_direction: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None,
        used_time: Optional[int] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
resources:  _:    type: alicloud:dts:Instance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AutoPay bool
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
AutoStart bool
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
ComputeUnit int
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
CreateTime string
Instance creation time
DatabaseCount int
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
DestinationEndpointEngineName Changes to this property will trigger replacement. string
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
DestinationRegion Changes to this property will trigger replacement. string
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
DtsInstanceId string
The ID of the subscription instance.
Du int
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
FeeType string
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
InstanceClass Changes to this property will trigger replacement. string
The type of the migration or synchronization instance.

InstanceName string
The name of Dts instance.
JobId string
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
PaymentType Changes to this property will trigger replacement. string
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
Period string
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
ResourceGroupId string
Resource Group ID.
SourceEndpointEngineName Changes to this property will trigger replacement. string
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
SourceRegion Changes to this property will trigger replacement. string
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
Status string
Instance status.
SyncArchitecture string
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
SynchronizationDirection string
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
Tags Dictionary<string, string>
The tag value corresponding to the tag key.See the following Block Tags.
Type Changes to this property will trigger replacement. string
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
UsedTime int
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
AutoPay bool
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
AutoStart bool
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
ComputeUnit int
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
CreateTime string
Instance creation time
DatabaseCount int
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
DestinationEndpointEngineName Changes to this property will trigger replacement. string
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
DestinationRegion Changes to this property will trigger replacement. string
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
DtsInstanceId string
The ID of the subscription instance.
Du int
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
FeeType string
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
InstanceClass Changes to this property will trigger replacement. string
The type of the migration or synchronization instance.

InstanceName string
The name of Dts instance.
JobId string
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
PaymentType Changes to this property will trigger replacement. string
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
Period string
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
ResourceGroupId string
Resource Group ID.
SourceEndpointEngineName Changes to this property will trigger replacement. string
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
SourceRegion Changes to this property will trigger replacement. string
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
Status string
Instance status.
SyncArchitecture string
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
SynchronizationDirection string
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
Tags map[string]string
The tag value corresponding to the tag key.See the following Block Tags.
Type Changes to this property will trigger replacement. string
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
UsedTime int
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
autoPay Boolean
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
autoStart Boolean
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
computeUnit Integer
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
createTime String
Instance creation time
databaseCount Integer
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
destinationEndpointEngineName Changes to this property will trigger replacement. String
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
destinationRegion Changes to this property will trigger replacement. String
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
dtsInstanceId String
The ID of the subscription instance.
du Integer
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
feeType String
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
instanceClass Changes to this property will trigger replacement. String
The type of the migration or synchronization instance.

instanceName String
The name of Dts instance.
jobId String
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
paymentType Changes to this property will trigger replacement. String
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
period String
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
resourceGroupId String
Resource Group ID.
sourceEndpointEngineName Changes to this property will trigger replacement. String
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
sourceRegion Changes to this property will trigger replacement. String
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
status String
Instance status.
syncArchitecture String
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
synchronizationDirection String
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
tags Map<String,String>
The tag value corresponding to the tag key.See the following Block Tags.
type Changes to this property will trigger replacement. String
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
usedTime Integer
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
autoPay boolean
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
autoStart boolean
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
computeUnit number
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
createTime string
Instance creation time
databaseCount number
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
destinationEndpointEngineName Changes to this property will trigger replacement. string
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
destinationRegion Changes to this property will trigger replacement. string
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
dtsInstanceId string
The ID of the subscription instance.
du number
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
feeType string
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
instanceClass Changes to this property will trigger replacement. string
The type of the migration or synchronization instance.

instanceName string
The name of Dts instance.
jobId string
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
paymentType Changes to this property will trigger replacement. string
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
period string
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
resourceGroupId string
Resource Group ID.
sourceEndpointEngineName Changes to this property will trigger replacement. string
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
sourceRegion Changes to this property will trigger replacement. string
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
status string
Instance status.
syncArchitecture string
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
synchronizationDirection string
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
tags {[key: string]: string}
The tag value corresponding to the tag key.See the following Block Tags.
type Changes to this property will trigger replacement. string
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
usedTime number
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
auto_pay bool
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
auto_start bool
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
compute_unit int
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
create_time str
Instance creation time
database_count int
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
destination_endpoint_engine_name Changes to this property will trigger replacement. str
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
destination_region Changes to this property will trigger replacement. str
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
dts_instance_id str
The ID of the subscription instance.
du int
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
fee_type str
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
instance_class Changes to this property will trigger replacement. str
The type of the migration or synchronization instance.

instance_name str
The name of Dts instance.
job_id str
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
payment_type Changes to this property will trigger replacement. str
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
period str
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
resource_group_id str
Resource Group ID.
source_endpoint_engine_name Changes to this property will trigger replacement. str
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
source_region Changes to this property will trigger replacement. str
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
status str
Instance status.
sync_architecture str
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
synchronization_direction str
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
tags Mapping[str, str]
The tag value corresponding to the tag key.See the following Block Tags.
type Changes to this property will trigger replacement. str
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
used_time int
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.
autoPay Boolean
Whether to automatically renew the fee when it expires. Valid values:

  • false: No, the default value.
  • true: Yes.
autoStart Boolean
Whether to start the task automatically after the purchase is completed. Value:

  • false: No, the default value.
  • true: Yes.
computeUnit Number
Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. NOTE: Enter this parameter and enable ETL to clean and convert data.
createTime String
Instance creation time
databaseCount Number
The number of private custom RDS instances in the PolarDB-X. The default value is 1. NOTE: This parameter is required only when source_endpoint_engine_name is DRDS.
destinationEndpointEngineName Changes to this property will trigger replacement. String
The target database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute project.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
destinationRegion Changes to this property will trigger replacement. String
The target instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
dtsInstanceId String
The ID of the subscription instance.
du Number
Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: 1 ~ 100. NOTE: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
feeType String
Subscription billing type, Valid values: ONLY_CONFIGURATION_FEE: charges only configuration fees; CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.
instanceClass Changes to this property will trigger replacement. String
The type of the migration or synchronization instance.

instanceName String
The name of Dts instance.
jobId String
The ID of the task obtained by calling the ConfigureDtsJob operation (DtsJobId).> After you pass in this parameter, you do not need to pass the source_region, destination_region, type, source_endpoint_engine_name, or destination_endpoint_engine_name parameters. Even if the input is passed in, the configuration in job_id shall prevail.
paymentType Changes to this property will trigger replacement. String
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
period String
The billing method of the subscription instance. Value: Year, Month. NOTE: This parameter is valid and must be passed in only when payment_type is Subscription.
resourceGroupId String
Resource Group ID.
sourceEndpointEngineName Changes to this property will trigger replacement. String
Source instance database engine type.

  • MySQL:MySQL databases (including RDS MySQL and self-built MySQL).
  • PolarDB:PolarDB MySQL.
  • polardb_o:PolarDB O engine.
  • polardb_pg:PolarDB PostgreSQL.
  • Redis:Redis databases (including apsaradb for Redis and user-created Redis).
  • DRDS: cloud-native distributed database PolarDB-X 1.0 and 2.0.
  • PostgreSQL: User-created PostgreSQL.
  • ODPS:MaxCompute.
  • oracle: self-built Oracle.
  • mongodb:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
  • tidb:TiDB database.
  • ADS: Cloud native data warehouse AnalyticDB MySQL 2.0.
  • ADB30: Cloud native data warehouse AnalyticDB MySQL 3.0.
  • Greenplum: Cloud native data warehouse AnalyticDB PostgreSQL.
  • MSSQL:SQL Server databases (including RDS SQL Server and self-built SQL Server).
  • kafka:Kafka databases (including Kafka and self-built Kafka).
  • DataHub: DataHub, an Alibaba cloud streaming data service.
  • clickhouse: ClickHouse.
  • DB2: self-built DB2 LUW.
  • as400:AS/400.
  • Tablestore: Tablestore.
  • NOTE:
  • The default value is MySQL.
  • For more information about the supported source and destination databases, see Database, Synchronization Initialization Type, and Synchronization Topology and Supported Database and Migration Type.
  • This parameter or job_id must be passed in.
sourceRegion Changes to this property will trigger replacement. String
The source instance region. For more information, see List of supported regions. NOTE: This parameter or job_id must be passed in.
status String
Instance status.
syncArchitecture String
Synchronization topology, value:

  • oneway: one-way synchronization, the default value.
  • bidirectional: two-way synchronization.
synchronizationDirection String
The synchronization direction. Default value: Forward. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
  • NOTE: You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
tags Map<String>
The tag value corresponding to the tag key.See the following Block Tags.
type Changes to this property will trigger replacement. String
The instance type. Valid values:

  • migration: MIGRATION.
  • sync: synchronization.
  • subscribe: SUBSCRIBE.
  • NOTE: This parameter or job_id must be passed in.
usedTime Number
Prepaid instance purchase duration.

  • When period is Month, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When Period is Year, the values are 1, 2, 3, and 5.
  • NOTE:
  • This parameter is valid and must be passed in only when payment_type is Subscription.
  • The billing method of the subscription instance. You can set the parameter period.

Import

Dts Instance can be imported using the id, e.g.

$ pulumi import alicloud:dts/instance:Instance example <id>
Copy

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.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud