Alibaba Cloud v3.76.0, Apr 8 25

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.dts.MigrationJob

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

Create MigrationJob Resource

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

new MigrationJob(name: string, args: MigrationJobArgs, opts?: CustomResourceOptions);

@overload
def MigrationJob(resource_name: str,
                 args: MigrationJobArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def MigrationJob(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 dts_instance_id: Optional[str] = None,
                 data_initialization: Optional[bool] = None,
                 data_synchronization: Optional[bool] = None,
                 db_list: Optional[str] = None,
                 structure_initialization: Optional[bool] = None,
                 destination_endpoint_engine_name: Optional[str] = None,
                 source_endpoint_instance_type: Optional[str] = None,
                 destination_endpoint_instance_type: Optional[str] = None,
                 source_endpoint_engine_name: Optional[str] = None,
                 instance_class: Optional[str] = None,
                 destination_endpoint_instance_id: Optional[str] = None,
                 destination_endpoint_port: Optional[str] = None,
                 destination_endpoint_region: Optional[str] = None,
                 destination_endpoint_user_name: Optional[str] = None,
                 destination_endpoint_oracle_sid: Optional[str] = None,
                 checkpoint: Optional[str] = None,
                 destination_endpoint_ip: Optional[str] = None,
                 source_endpoint_database_name: Optional[str] = None,
                 dts_job_name: Optional[str] = None,
                 source_endpoint_instance_id: Optional[str] = None,
                 destination_endpoint_password: Optional[str] = None,
                 source_endpoint_ip: Optional[str] = None,
                 source_endpoint_oracle_sid: Optional[str] = None,
                 source_endpoint_owner_id: Optional[str] = None,
                 source_endpoint_password: Optional[str] = None,
                 source_endpoint_port: Optional[str] = None,
                 source_endpoint_region: Optional[str] = None,
                 source_endpoint_role: Optional[str] = None,
                 source_endpoint_user_name: Optional[str] = None,
                 status: Optional[str] = None,
                 destination_endpoint_database_name: Optional[str] = None)

func NewMigrationJob(ctx *Context, name string, args MigrationJobArgs, opts ...ResourceOption) (*MigrationJob, error)

public MigrationJob(string name, MigrationJobArgs args, CustomResourceOptions? opts = null)

public MigrationJob(String name, MigrationJobArgs args)
public MigrationJob(String name, MigrationJobArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args MigrationJobArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args MigrationJobArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MigrationJobArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MigrationJobArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args MigrationJobArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var migrationJobResource = new AliCloud.Dts.MigrationJob("migrationJobResource", new()
{
    DtsInstanceId = "string",
    DataInitialization = false,
    DataSynchronization = false,
    DbList = "string",
    StructureInitialization = false,
    DestinationEndpointEngineName = "string",
    SourceEndpointInstanceType = "string",
    DestinationEndpointInstanceType = "string",
    SourceEndpointEngineName = "string",
    InstanceClass = "string",
    DestinationEndpointInstanceId = "string",
    DestinationEndpointPort = "string",
    DestinationEndpointRegion = "string",
    DestinationEndpointUserName = "string",
    DestinationEndpointOracleSid = "string",
    Checkpoint = "string",
    DestinationEndpointIp = "string",
    SourceEndpointDatabaseName = "string",
    DtsJobName = "string",
    SourceEndpointInstanceId = "string",
    DestinationEndpointPassword = "string",
    SourceEndpointIp = "string",
    SourceEndpointOracleSid = "string",
    SourceEndpointOwnerId = "string",
    SourceEndpointPassword = "string",
    SourceEndpointPort = "string",
    SourceEndpointRegion = "string",
    SourceEndpointRole = "string",
    SourceEndpointUserName = "string",
    Status = "string",
    DestinationEndpointDatabaseName = "string",
});

example, err := dts.NewMigrationJob(ctx, "migrationJobResource", &dts.MigrationJobArgs{
	DtsInstanceId:                   pulumi.String("string"),
	DataInitialization:              pulumi.Bool(false),
	DataSynchronization:             pulumi.Bool(false),
	DbList:                          pulumi.String("string"),
	StructureInitialization:         pulumi.Bool(false),
	DestinationEndpointEngineName:   pulumi.String("string"),
	SourceEndpointInstanceType:      pulumi.String("string"),
	DestinationEndpointInstanceType: pulumi.String("string"),
	SourceEndpointEngineName:        pulumi.String("string"),
	InstanceClass:                   pulumi.String("string"),
	DestinationEndpointInstanceId:   pulumi.String("string"),
	DestinationEndpointPort:         pulumi.String("string"),
	DestinationEndpointRegion:       pulumi.String("string"),
	DestinationEndpointUserName:     pulumi.String("string"),
	DestinationEndpointOracleSid:    pulumi.String("string"),
	Checkpoint:                      pulumi.String("string"),
	DestinationEndpointIp:           pulumi.String("string"),
	SourceEndpointDatabaseName:      pulumi.String("string"),
	DtsJobName:                      pulumi.String("string"),
	SourceEndpointInstanceId:        pulumi.String("string"),
	DestinationEndpointPassword:     pulumi.String("string"),
	SourceEndpointIp:                pulumi.String("string"),
	SourceEndpointOracleSid:         pulumi.String("string"),
	SourceEndpointOwnerId:           pulumi.String("string"),
	SourceEndpointPassword:          pulumi.String("string"),
	SourceEndpointPort:              pulumi.String("string"),
	SourceEndpointRegion:            pulumi.String("string"),
	SourceEndpointRole:              pulumi.String("string"),
	SourceEndpointUserName:          pulumi.String("string"),
	Status:                          pulumi.String("string"),
	DestinationEndpointDatabaseName: pulumi.String("string"),
})

var migrationJobResource = new MigrationJob("migrationJobResource", MigrationJobArgs.builder()
    .dtsInstanceId("string")
    .dataInitialization(false)
    .dataSynchronization(false)
    .dbList("string")
    .structureInitialization(false)
    .destinationEndpointEngineName("string")
    .sourceEndpointInstanceType("string")
    .destinationEndpointInstanceType("string")
    .sourceEndpointEngineName("string")
    .instanceClass("string")
    .destinationEndpointInstanceId("string")
    .destinationEndpointPort("string")
    .destinationEndpointRegion("string")
    .destinationEndpointUserName("string")
    .destinationEndpointOracleSid("string")
    .checkpoint("string")
    .destinationEndpointIp("string")
    .sourceEndpointDatabaseName("string")
    .dtsJobName("string")
    .sourceEndpointInstanceId("string")
    .destinationEndpointPassword("string")
    .sourceEndpointIp("string")
    .sourceEndpointOracleSid("string")
    .sourceEndpointOwnerId("string")
    .sourceEndpointPassword("string")
    .sourceEndpointPort("string")
    .sourceEndpointRegion("string")
    .sourceEndpointRole("string")
    .sourceEndpointUserName("string")
    .status("string")
    .destinationEndpointDatabaseName("string")
    .build());

migration_job_resource = alicloud.dts.MigrationJob("migrationJobResource",
    dts_instance_id="string",
    data_initialization=False,
    data_synchronization=False,
    db_list="string",
    structure_initialization=False,
    destination_endpoint_engine_name="string",
    source_endpoint_instance_type="string",
    destination_endpoint_instance_type="string",
    source_endpoint_engine_name="string",
    instance_class="string",
    destination_endpoint_instance_id="string",
    destination_endpoint_port="string",
    destination_endpoint_region="string",
    destination_endpoint_user_name="string",
    destination_endpoint_oracle_sid="string",
    checkpoint="string",
    destination_endpoint_ip="string",
    source_endpoint_database_name="string",
    dts_job_name="string",
    source_endpoint_instance_id="string",
    destination_endpoint_password="string",
    source_endpoint_ip="string",
    source_endpoint_oracle_sid="string",
    source_endpoint_owner_id="string",
    source_endpoint_password="string",
    source_endpoint_port="string",
    source_endpoint_region="string",
    source_endpoint_role="string",
    source_endpoint_user_name="string",
    status="string",
    destination_endpoint_database_name="string")

const migrationJobResource = new alicloud.dts.MigrationJob("migrationJobResource", {
    dtsInstanceId: "string",
    dataInitialization: false,
    dataSynchronization: false,
    dbList: "string",
    structureInitialization: false,
    destinationEndpointEngineName: "string",
    sourceEndpointInstanceType: "string",
    destinationEndpointInstanceType: "string",
    sourceEndpointEngineName: "string",
    instanceClass: "string",
    destinationEndpointInstanceId: "string",
    destinationEndpointPort: "string",
    destinationEndpointRegion: "string",
    destinationEndpointUserName: "string",
    destinationEndpointOracleSid: "string",
    checkpoint: "string",
    destinationEndpointIp: "string",
    sourceEndpointDatabaseName: "string",
    dtsJobName: "string",
    sourceEndpointInstanceId: "string",
    destinationEndpointPassword: "string",
    sourceEndpointIp: "string",
    sourceEndpointOracleSid: "string",
    sourceEndpointOwnerId: "string",
    sourceEndpointPassword: "string",
    sourceEndpointPort: "string",
    sourceEndpointRegion: "string",
    sourceEndpointRole: "string",
    sourceEndpointUserName: "string",
    status: "string",
    destinationEndpointDatabaseName: "string",
});

type: alicloud:dts:MigrationJob
properties:
    checkpoint: string
    dataInitialization: false
    dataSynchronization: false
    dbList: string
    destinationEndpointDatabaseName: string
    destinationEndpointEngineName: string
    destinationEndpointInstanceId: string
    destinationEndpointInstanceType: string
    destinationEndpointIp: string
    destinationEndpointOracleSid: string
    destinationEndpointPassword: string
    destinationEndpointPort: string
    destinationEndpointRegion: string
    destinationEndpointUserName: string
    dtsInstanceId: string
    dtsJobName: string
    instanceClass: string
    sourceEndpointDatabaseName: string
    sourceEndpointEngineName: string
    sourceEndpointInstanceId: string
    sourceEndpointInstanceType: string
    sourceEndpointIp: string
    sourceEndpointOracleSid: string
    sourceEndpointOwnerId: string
    sourceEndpointPassword: string
    sourceEndpointPort: string
    sourceEndpointRegion: string
    sourceEndpointRole: string
    sourceEndpointUserName: string
    status: string
    structureInitialization: false

MigrationJob 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 MigrationJob resource accepts the following input properties:

DataInitialization bool: Whether to execute DTS supports schema migration.
DataSynchronization bool: Whether to perform incremental data migration.
DbList string: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
DestinationEndpointEngineName string: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
DestinationEndpointInstanceType string: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
DtsInstanceId string: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
SourceEndpointEngineName string: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
SourceEndpointInstanceType string: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
StructureInitialization bool: Whether to perform a database table structure to migrate.
Checkpoint string: Start time in Unix timestamp format.
DestinationEndpointDatabaseName string: The name of migrate the database.
DestinationEndpointInstanceId string: The ID of destination instance.
DestinationEndpointIp string: The ip of source endpoint.
DestinationEndpointOracleSid string: The SID of Oracle database.
DestinationEndpointPassword string: The password of database account.
DestinationEndpointPort string: The port of source endpoint.
DestinationEndpointRegion string: The region of destination instance.
DestinationEndpointUserName string: The username of database account.
DtsJobName string: The name of migration job.
InstanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
SourceEndpointDatabaseName string: The name of migrate the database.
SourceEndpointInstanceId string: The ID of source instance.
SourceEndpointIp string: The ip of source endpoint.
SourceEndpointOracleSid string: The SID of Oracle database.
SourceEndpointOwnerId string: The Alibaba Cloud account ID to which the source instance belongs.
SourceEndpointPassword string: The password of database account.
SourceEndpointPort string: The port of source endpoint.
SourceEndpointRegion string: The region of source instance.
SourceEndpointRole string: The name of the role configured for the cloud account to which the source instance belongs.
SourceEndpointUserName string: The username of database account.
Status string: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.

DataInitialization bool: Whether to execute DTS supports schema migration.
DataSynchronization bool: Whether to perform incremental data migration.
DbList string: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
DestinationEndpointEngineName string: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
DestinationEndpointInstanceType string: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
DtsInstanceId string: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
SourceEndpointEngineName string: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
SourceEndpointInstanceType string: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
StructureInitialization bool: Whether to perform a database table structure to migrate.
Checkpoint string: Start time in Unix timestamp format.
DestinationEndpointDatabaseName string: The name of migrate the database.
DestinationEndpointInstanceId string: The ID of destination instance.
DestinationEndpointIp string: The ip of source endpoint.
DestinationEndpointOracleSid string: The SID of Oracle database.
DestinationEndpointPassword string: The password of database account.
DestinationEndpointPort string: The port of source endpoint.
DestinationEndpointRegion string: The region of destination instance.
DestinationEndpointUserName string: The username of database account.
DtsJobName string: The name of migration job.
InstanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
SourceEndpointDatabaseName string: The name of migrate the database.
SourceEndpointInstanceId string: The ID of source instance.
SourceEndpointIp string: The ip of source endpoint.
SourceEndpointOracleSid string: The SID of Oracle database.
SourceEndpointOwnerId string: The Alibaba Cloud account ID to which the source instance belongs.
SourceEndpointPassword string: The password of database account.
SourceEndpointPort string: The port of source endpoint.
SourceEndpointRegion string: The region of source instance.
SourceEndpointRole string: The name of the role configured for the cloud account to which the source instance belongs.
SourceEndpointUserName string: The username of database account.
Status string: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.

dataInitialization Boolean: Whether to execute DTS supports schema migration.
dataSynchronization Boolean: Whether to perform incremental data migration.
dbList String: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
destinationEndpointEngineName String: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
destinationEndpointInstanceType String: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
dtsInstanceId String: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
sourceEndpointEngineName String: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
sourceEndpointInstanceType String: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
structureInitialization Boolean: Whether to perform a database table structure to migrate.
checkpoint String: Start time in Unix timestamp format.
destinationEndpointDatabaseName String: The name of migrate the database.
destinationEndpointInstanceId String: The ID of destination instance.
destinationEndpointIp String: The ip of source endpoint.
destinationEndpointOracleSid String: The SID of Oracle database.
destinationEndpointPassword String: The password of database account.
destinationEndpointPort String: The port of source endpoint.
destinationEndpointRegion String: The region of destination instance.
destinationEndpointUserName String: The username of database account.
dtsJobName String: The name of migration job.
instanceClass String: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
sourceEndpointDatabaseName String: The name of migrate the database.
sourceEndpointInstanceId String: The ID of source instance.
sourceEndpointIp String: The ip of source endpoint.
sourceEndpointOracleSid String: The SID of Oracle database.
sourceEndpointOwnerId String: The Alibaba Cloud account ID to which the source instance belongs.
sourceEndpointPassword String: The password of database account.
sourceEndpointPort String: The port of source endpoint.
sourceEndpointRegion String: The region of source instance.
sourceEndpointRole String: The name of the role configured for the cloud account to which the source instance belongs.
sourceEndpointUserName String: The username of database account.
status String: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.

dataInitialization boolean: Whether to execute DTS supports schema migration.
dataSynchronization boolean: Whether to perform incremental data migration.
dbList string: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
destinationEndpointEngineName string: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
destinationEndpointInstanceType string: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
dtsInstanceId string: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
sourceEndpointEngineName string: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
sourceEndpointInstanceType string: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
structureInitialization boolean: Whether to perform a database table structure to migrate.
checkpoint string: Start time in Unix timestamp format.
destinationEndpointDatabaseName string: The name of migrate the database.
destinationEndpointInstanceId string: The ID of destination instance.
destinationEndpointIp string: The ip of source endpoint.
destinationEndpointOracleSid string: The SID of Oracle database.
destinationEndpointPassword string: The password of database account.
destinationEndpointPort string: The port of source endpoint.
destinationEndpointRegion string: The region of destination instance.
destinationEndpointUserName string: The username of database account.
dtsJobName string: The name of migration job.
instanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
sourceEndpointDatabaseName string: The name of migrate the database.
sourceEndpointInstanceId string: The ID of source instance.
sourceEndpointIp string: The ip of source endpoint.
sourceEndpointOracleSid string: The SID of Oracle database.
sourceEndpointOwnerId string: The Alibaba Cloud account ID to which the source instance belongs.
sourceEndpointPassword string: The password of database account.
sourceEndpointPort string: The port of source endpoint.
sourceEndpointRegion string: The region of source instance.
sourceEndpointRole string: The name of the role configured for the cloud account to which the source instance belongs.
sourceEndpointUserName string: The username of database account.
status string: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.

data_initialization bool: Whether to execute DTS supports schema migration.
data_synchronization bool: Whether to perform incremental data migration.
db_list str: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
destination_endpoint_engine_name str: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
destination_endpoint_instance_type str: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
dts_instance_id str: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
source_endpoint_engine_name str: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
source_endpoint_instance_type str: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
structure_initialization bool: Whether to perform a database table structure to migrate.
checkpoint str: Start time in Unix timestamp format.
destination_endpoint_database_name str: The name of migrate the database.
destination_endpoint_instance_id str: The ID of destination instance.
destination_endpoint_ip str: The ip of source endpoint.
destination_endpoint_oracle_sid str: The SID of Oracle database.
destination_endpoint_password str: The password of database account.
destination_endpoint_port str: The port of source endpoint.
destination_endpoint_region str: The region of destination instance.
destination_endpoint_user_name str: The username of database account.
dts_job_name str: The name of migration job.
instance_class str: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
source_endpoint_database_name str: The name of migrate the database.
source_endpoint_instance_id str: The ID of source instance.
source_endpoint_ip str: The ip of source endpoint.
source_endpoint_oracle_sid str: The SID of Oracle database.
source_endpoint_owner_id str: The Alibaba Cloud account ID to which the source instance belongs.
source_endpoint_password str: The password of database account.
source_endpoint_port str: The port of source endpoint.
source_endpoint_region str: The region of source instance.
source_endpoint_role str: The name of the role configured for the cloud account to which the source instance belongs.
source_endpoint_user_name str: The username of database account.
status str: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.

dataInitialization Boolean: Whether to execute DTS supports schema migration.
dataSynchronization Boolean: Whether to perform incremental data migration.
dbList String: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
destinationEndpointEngineName String: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
destinationEndpointInstanceType String: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
dtsInstanceId String: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
sourceEndpointEngineName String: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
sourceEndpointInstanceType String: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
structureInitialization Boolean: Whether to perform a database table structure to migrate.
checkpoint String: Start time in Unix timestamp format.
destinationEndpointDatabaseName String: The name of migrate the database.
destinationEndpointInstanceId String: The ID of destination instance.
destinationEndpointIp String: The ip of source endpoint.
destinationEndpointOracleSid String: The SID of Oracle database.
destinationEndpointPassword String: The password of database account.
destinationEndpointPort String: The port of source endpoint.
destinationEndpointRegion String: The region of destination instance.
destinationEndpointUserName String: The username of database account.
dtsJobName String: The name of migration job.
instanceClass String: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
sourceEndpointDatabaseName String: The name of migrate the database.
sourceEndpointInstanceId String: The ID of source instance.
sourceEndpointIp String: The ip of source endpoint.
sourceEndpointOracleSid String: The SID of Oracle database.
sourceEndpointOwnerId String: The Alibaba Cloud account ID to which the source instance belongs.
sourceEndpointPassword String: The password of database account.
sourceEndpointPort String: The port of source endpoint.
sourceEndpointRegion String: The region of source instance.
sourceEndpointRole String: The name of the role configured for the cloud account to which the source instance belongs.
sourceEndpointUserName String: The username of database account.
status String: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing MigrationJob Resource

Get an existing MigrationJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: MigrationJobState, opts?: CustomResourceOptions): MigrationJob

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        checkpoint: Optional[str] = None,
        data_initialization: Optional[bool] = None,
        data_synchronization: Optional[bool] = None,
        db_list: Optional[str] = None,
        destination_endpoint_database_name: Optional[str] = None,
        destination_endpoint_engine_name: Optional[str] = None,
        destination_endpoint_instance_id: Optional[str] = None,
        destination_endpoint_instance_type: Optional[str] = None,
        destination_endpoint_ip: Optional[str] = None,
        destination_endpoint_oracle_sid: Optional[str] = None,
        destination_endpoint_password: Optional[str] = None,
        destination_endpoint_port: Optional[str] = None,
        destination_endpoint_region: Optional[str] = None,
        destination_endpoint_user_name: Optional[str] = None,
        dts_instance_id: Optional[str] = None,
        dts_job_name: Optional[str] = None,
        instance_class: Optional[str] = None,
        source_endpoint_database_name: Optional[str] = None,
        source_endpoint_engine_name: Optional[str] = None,
        source_endpoint_instance_id: Optional[str] = None,
        source_endpoint_instance_type: Optional[str] = None,
        source_endpoint_ip: Optional[str] = None,
        source_endpoint_oracle_sid: Optional[str] = None,
        source_endpoint_owner_id: Optional[str] = None,
        source_endpoint_password: Optional[str] = None,
        source_endpoint_port: Optional[str] = None,
        source_endpoint_region: Optional[str] = None,
        source_endpoint_role: Optional[str] = None,
        source_endpoint_user_name: Optional[str] = None,
        status: Optional[str] = None,
        structure_initialization: Optional[bool] = None) -> MigrationJob

func GetMigrationJob(ctx *Context, name string, id IDInput, state *MigrationJobState, opts ...ResourceOption) (*MigrationJob, error)

public static MigrationJob Get(string name, Input<string> id, MigrationJobState? state, CustomResourceOptions? opts = null)

public static MigrationJob get(String name, Output<String> id, MigrationJobState state, CustomResourceOptions options)

resources:  _:    type: alicloud:dts:MigrationJob    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Checkpoint string: Start time in Unix timestamp format.
DataInitialization bool: Whether to execute DTS supports schema migration.
DataSynchronization bool: Whether to perform incremental data migration.
DbList string: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
DestinationEndpointDatabaseName string: The name of migrate the database.
DestinationEndpointEngineName string: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
DestinationEndpointInstanceId string: The ID of destination instance.
DestinationEndpointInstanceType string: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
DestinationEndpointIp string: The ip of source endpoint.
DestinationEndpointOracleSid string: The SID of Oracle database.
DestinationEndpointPassword string: The password of database account.
DestinationEndpointPort string: The port of source endpoint.
DestinationEndpointRegion string: The region of destination instance.
DestinationEndpointUserName string: The username of database account.
DtsInstanceId string: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
DtsJobName string: The name of migration job.
InstanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
SourceEndpointDatabaseName string: The name of migrate the database.
SourceEndpointEngineName string: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
SourceEndpointInstanceId string: The ID of source instance.
SourceEndpointInstanceType string: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
SourceEndpointIp string: The ip of source endpoint.
SourceEndpointOracleSid string: The SID of Oracle database.
SourceEndpointOwnerId string: The Alibaba Cloud account ID to which the source instance belongs.
SourceEndpointPassword string: The password of database account.
SourceEndpointPort string: The port of source endpoint.
SourceEndpointRegion string: The region of source instance.
SourceEndpointRole string: The name of the role configured for the cloud account to which the source instance belongs.
SourceEndpointUserName string: The username of database account.
Status string: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.
StructureInitialization bool: Whether to perform a database table structure to migrate.

Checkpoint string: Start time in Unix timestamp format.
DataInitialization bool: Whether to execute DTS supports schema migration.
DataSynchronization bool: Whether to perform incremental data migration.
DbList string: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
DestinationEndpointDatabaseName string: The name of migrate the database.
DestinationEndpointEngineName string: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
DestinationEndpointInstanceId string: The ID of destination instance.
DestinationEndpointInstanceType string: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
DestinationEndpointIp string: The ip of source endpoint.
DestinationEndpointOracleSid string: The SID of Oracle database.
DestinationEndpointPassword string: The password of database account.
DestinationEndpointPort string: The port of source endpoint.
DestinationEndpointRegion string: The region of destination instance.
DestinationEndpointUserName string: The username of database account.
DtsInstanceId string: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
DtsJobName string: The name of migration job.
InstanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
SourceEndpointDatabaseName string: The name of migrate the database.
SourceEndpointEngineName string: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
SourceEndpointInstanceId string: The ID of source instance.
SourceEndpointInstanceType string: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
SourceEndpointIp string: The ip of source endpoint.
SourceEndpointOracleSid string: The SID of Oracle database.
SourceEndpointOwnerId string: The Alibaba Cloud account ID to which the source instance belongs.
SourceEndpointPassword string: The password of database account.
SourceEndpointPort string: The port of source endpoint.
SourceEndpointRegion string: The region of source instance.
SourceEndpointRole string: The name of the role configured for the cloud account to which the source instance belongs.
SourceEndpointUserName string: The username of database account.
Status string: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.
StructureInitialization bool: Whether to perform a database table structure to migrate.

checkpoint String: Start time in Unix timestamp format.
dataInitialization Boolean: Whether to execute DTS supports schema migration.
dataSynchronization Boolean: Whether to perform incremental data migration.
dbList String: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
destinationEndpointDatabaseName String: The name of migrate the database.
destinationEndpointEngineName String: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
destinationEndpointInstanceId String: The ID of destination instance.
destinationEndpointInstanceType String: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
destinationEndpointIp String: The ip of source endpoint.
destinationEndpointOracleSid String: The SID of Oracle database.
destinationEndpointPassword String: The password of database account.
destinationEndpointPort String: The port of source endpoint.
destinationEndpointRegion String: The region of destination instance.
destinationEndpointUserName String: The username of database account.
dtsInstanceId String: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
dtsJobName String: The name of migration job.
instanceClass String: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
sourceEndpointDatabaseName String: The name of migrate the database.
sourceEndpointEngineName String: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
sourceEndpointInstanceId String: The ID of source instance.
sourceEndpointInstanceType String: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
sourceEndpointIp String: The ip of source endpoint.
sourceEndpointOracleSid String: The SID of Oracle database.
sourceEndpointOwnerId String: The Alibaba Cloud account ID to which the source instance belongs.
sourceEndpointPassword String: The password of database account.
sourceEndpointPort String: The port of source endpoint.
sourceEndpointRegion String: The region of source instance.
sourceEndpointRole String: The name of the role configured for the cloud account to which the source instance belongs.
sourceEndpointUserName String: The username of database account.
status String: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.
structureInitialization Boolean: Whether to perform a database table structure to migrate.

checkpoint string: Start time in Unix timestamp format.
dataInitialization boolean: Whether to execute DTS supports schema migration.
dataSynchronization boolean: Whether to perform incremental data migration.
dbList string: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
destinationEndpointDatabaseName string: The name of migrate the database.
destinationEndpointEngineName string: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
destinationEndpointInstanceId string: The ID of destination instance.
destinationEndpointInstanceType string: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
destinationEndpointIp string: The ip of source endpoint.
destinationEndpointOracleSid string: The SID of Oracle database.
destinationEndpointPassword string: The password of database account.
destinationEndpointPort string: The port of source endpoint.
destinationEndpointRegion string: The region of destination instance.
destinationEndpointUserName string: The username of database account.
dtsInstanceId string: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
dtsJobName string: The name of migration job.
instanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
sourceEndpointDatabaseName string: The name of migrate the database.
sourceEndpointEngineName string: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
sourceEndpointInstanceId string: The ID of source instance.
sourceEndpointInstanceType string: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
sourceEndpointIp string: The ip of source endpoint.
sourceEndpointOracleSid string: The SID of Oracle database.
sourceEndpointOwnerId string: The Alibaba Cloud account ID to which the source instance belongs.
sourceEndpointPassword string: The password of database account.
sourceEndpointPort string: The port of source endpoint.
sourceEndpointRegion string: The region of source instance.
sourceEndpointRole string: The name of the role configured for the cloud account to which the source instance belongs.
sourceEndpointUserName string: The username of database account.
status string: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.
structureInitialization boolean: Whether to perform a database table structure to migrate.

checkpoint str: Start time in Unix timestamp format.
data_initialization bool: Whether to execute DTS supports schema migration.
data_synchronization bool: Whether to perform incremental data migration.
db_list str: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
destination_endpoint_database_name str: The name of migrate the database.
destination_endpoint_engine_name str: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
destination_endpoint_instance_id str: The ID of destination instance.
destination_endpoint_instance_type str: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
destination_endpoint_ip str: The ip of source endpoint.
destination_endpoint_oracle_sid str: The SID of Oracle database.
destination_endpoint_password str: The password of database account.
destination_endpoint_port str: The port of source endpoint.
destination_endpoint_region str: The region of destination instance.
destination_endpoint_user_name str: The username of database account.
dts_instance_id str: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
dts_job_name str: The name of migration job.
instance_class str: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
source_endpoint_database_name str: The name of migrate the database.
source_endpoint_engine_name str: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
source_endpoint_instance_id str: The ID of source instance.
source_endpoint_instance_type str: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
source_endpoint_ip str: The ip of source endpoint.
source_endpoint_oracle_sid str: The SID of Oracle database.
source_endpoint_owner_id str: The Alibaba Cloud account ID to which the source instance belongs.
source_endpoint_password str: The password of database account.
source_endpoint_port str: The port of source endpoint.
source_endpoint_region str: The region of source instance.
source_endpoint_role str: The name of the role configured for the cloud account to which the source instance belongs.
source_endpoint_user_name str: The username of database account.
status str: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.
structure_initialization bool: Whether to perform a database table structure to migrate.

checkpoint String: Start time in Unix timestamp format.
dataInitialization Boolean: Whether to execute DTS supports schema migration.
dataSynchronization Boolean: Whether to perform incremental data migration.
dbList String: Migration object, in the format of JSON strings. For detailed definition instructions, please refer to the description of migration, migration or subscription objects.
destinationEndpointDatabaseName String: The name of migrate the database.
destinationEndpointEngineName String: The type of destination database. Valid values: ADS, ADB30, AS400, DATAHUB, DB2, GREENPLUM, KAFKA, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, PostgreSQL.
destinationEndpointInstanceId String: The ID of destination instance.
destinationEndpointInstanceType String: The type of destination instance. Valid values: ADS, CEN, DATAHUB, DG, ECS, EXPRESS, GREENPLUM, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
destinationEndpointIp String: The ip of source endpoint.
destinationEndpointOracleSid String: The SID of Oracle database.
destinationEndpointPassword String: The password of database account.
destinationEndpointPort String: The port of source endpoint.
destinationEndpointRegion String: The region of destination instance.
destinationEndpointUserName String: The username of database account.
dtsInstanceId String: The Migration instance ID. The ID of alicloud.dts.MigrationInstance.
dtsJobName String: The name of migration job.
instanceClass String: The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
sourceEndpointDatabaseName String: The name of migrate the database.
sourceEndpointEngineName String: The type of source database. Valid values: AS400, DB2, DMSPOLARDB, HBASE, MONGODB, MSSQL, MySQL, ORACLE, PolarDB, POLARDBX20, POLARDB_O, POSTGRESQL, TERADATA.
sourceEndpointInstanceId String: The ID of source instance.
sourceEndpointInstanceType String: The type of source instance. Valid values: CEN, DG, DISTRIBUTED_DMSLOGICDB, ECS, EXPRESS, MONGODB, OTHER, PolarDB, POLARDBX20, RDS.
sourceEndpointIp String: The ip of source endpoint.
sourceEndpointOracleSid String: The SID of Oracle database.
sourceEndpointOwnerId String: The Alibaba Cloud account ID to which the source instance belongs.
sourceEndpointPassword String: The password of database account.
sourceEndpointPort String: The port of source endpoint.
sourceEndpointRegion String: The region of source instance.
sourceEndpointRole String: The name of the role configured for the cloud account to which the source instance belongs.
sourceEndpointUserName String: The username of database account.
status String: The status of the resource. Valid values: Migrating, Suspending. You can suspend the task by specifying Suspending and start the task by specifying Migrating.
structureInitialization Boolean: Whether to perform a database table structure to migrate.

Import

DTS Migration Job can be imported using the id, e.g.

$ pulumi import alicloud:dts/migrationJob:MigrationJob example <id>

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

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.dts.MigrationJob

On this page

On this page

Create MigrationJob Resource

Constructor syntax

Parameters

Constructor example

MigrationJob Resource Properties

Inputs

Outputs

Look up Existing MigrationJob Resource

Import

Package Details

On this page

On this page