use ALIYUN::DTS::MigrationJob to purchase a data migration instance - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "ALIYUN::DTS::MigrationJob",
  "Properties": {
    "MigrationJobClass": String,
    "SourceEndpoint": Map,
    "MigrationJobName": String,
    "MigrationMode": Map,
    "DestinationEndpoint": Map,
    "MigrationObject": List
  }
}

Propriedades

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
MigrationJobClass	String	Sim	Não	Especificação da instância de migração de dados.	Valores válidos: small medium large Para obter mais informações sobre os testes de desempenho de cada especificação, consulte Especificações de instâncias de migração de dados.
SourceEndpoint	Map	Não	Sim	Configurações da instância de origem.	Nenhuma.
MigrationJobName	String	Não	Sim	Nome da tarefa de migração de dados.	Nenhuma.
MigrationMode	Map	Não	Sim	Modo da tarefa de migração de dados.	Nenhuma.
DestinationEndpoint	Map	Não	Sim	Configurações da instância de destino.	Nenhuma.
MigrationObject	List	Não	Sim	Objetos a serem migrados.	Nenhuma.

Sintaxe de SourceEndpoint

"SourceEndpoint": {
  "UserName": String,
  "OracleSID": String,
  "InstanceID": String,
  "IP": String,
  "Region": String,
  "InstanceType": String,
  "Role": String,
  "DatabaseName": String,
  "OwnerID": String,
  "EngineName": String,
  "Password": String,
  "Port": String
}

Propriedades de SourceEndpoint

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
UserName	String	Sim	Sim	Nome de usuário usado para acessar a instância de origem.	Nenhuma.
OracleSID	String	Não	Sim	ID do sistema (SID) do banco de dados Oracle de origem, caso o tipo de mecanismo da instância de origem seja Oracle.	Nenhuma.
InstanceID	String	Não	Sim	ID da instância de origem.	Especifique esta propriedade com base no valor de InstanceType.
IP	String	Não	Sim	Endereço IP da instância de origem.	Especifique esta propriedade quando a instância de origem for um banco de dados autogerenciado local.
Region	String	Sim	Sim	ID da região da instância de origem.	Nenhuma.
InstanceType	String	Sim	Sim	Tipo da instância de origem.	Valores válidos: RDS: instância ApsaraDB RDS ECS: banco de dados autogerenciado hospedado em uma instância Elastic Compute Service (ECS) LocalInstance: banco de dados autogerenciado com endereço IP público Express: banco de dados autogerenciado conectado via circuito Express Connect MongoDB: instância ApsaraDB for MongoDB POLARDB: cluster PolarDB for MySQL
Role	String	Não	Sim	Nome da função do Resource Access Management (RAM) autorizada pela conta Alibaba Cloud à qual a instância de origem pertence. Esta propriedade entra em vigor quando a instância de origem é uma instância ApsaraDB RDS e as instâncias de origem e destino pertencem a contas Alibaba Cloud diferentes.	Especifique esta propriedade ao migrar dados entre contas Alibaba Cloud diferentes. Para obter mais informações sobre as permissões necessárias da função RAM e como concedê-las, consulte Configurar autorização RAM para tarefas DTS entre contas.
DatabaseName	String	Não	Sim	Nome do banco de dados.	Esta propriedade define o nome do banco de dados usado para estabelecer conexão caso o tipo de mecanismo da instância de origem seja PostgreSQL ou MongoDB.
OwnerID	String	Não	Sim	ID da conta Alibaba Cloud à qual a instância de origem pertence. Esta propriedade entra em vigor quando a instância de origem é uma instância ApsaraDB RDS e as instâncias de origem e destino pertencem a contas Alibaba Cloud diferentes.	Nenhuma.
EngineName	String	Não	Sim	Tipo de mecanismo da instância de origem.	Valores válidos: MySQL SQLServer PostgreSQL Oracle MongoDB Redis Especifique esta propriedade quando InstanceType não estiver definido como RDS.
Password	String	Sim	Sim	Senha usada para acessar a instância de origem.	Nenhuma.
Port	String	Não	Sim	Porta de escuta da instância de origem.	Especifique esta propriedade quando a instância de origem for um banco de dados autogerenciado.

Sintaxe de MigrationMode

"MigrationMode": {
  "DataIntialization": Boolean,
  "StructureIntialization": Boolean,
  "DataSynchronization": Boolean
}

Propriedades de MigrationMode

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
DataIntialization	Boolean	Não	Sim	Defina se a migração completa de dados será executada na tarefa de migração.	Valores válidos: true false
StructureIntialization	Boolean	Não	Sim	Defina se a migração de esquema será executada na tarefa de migração.	Valores válidos: true false
DataSynchronization	Boolean	Não	Sim	Defina se a sincronização incremental de dados será executada na tarefa de migração.	Valores válidos: true false

Sintaxe de DestinationEndpoint

"DestinationEndpoint": {
  "UserName": String,
  "InstanceID": String,
  "IP": String,
  "Region": String,
  "Port": String,
  "Role": String,
  "DatabaseName": String,
  "EngineName": String,
  "Password": String,
  "InstanceType": String
}

Propriedades de DestinationEndpoint

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
UserName	String	Sim	Sim	Nome de usuário usado para acessar a instância de destino.	Nenhuma.
InstanceID	String	Não	Sim	ID da instância de destino.	Nenhuma.
IP	String	Não	Sim	Endereço IP da instância de destino.	Especifique esta propriedade quando a instância de destino for um banco de dados autogerenciado local.
Region	String	Sim	Sim	ID da região da instância de destino.	Se a instância de destino for um banco de dados autogerenciado, especifique o ID da região geograficamente mais próxima do seu data center local.
Port	String	Não	Sim	Porta de escuta da instância de destino.	Especifique esta propriedade quando a instância de destino for um banco de dados autogerenciado.
DatabaseName	String	Não	Sim	Nome do banco de dados da instância de destino.	Especifique esta propriedade quando o tipo de mecanismo da instância de destino for PostgreSQL, PPAS ou MongoDB.
EngineName	String	Não	Sim	Tipo de mecanismo do banco de dados de destino.	Especifique esta propriedade apenas quando InstanceType estiver definido como RDS, ECS, LocalInstance ou Express.
Password	String	Sim	Sim	Senha usada para acessar a instância de destino.	Nenhuma.
InstanceType	String	Sim	Sim	Tipo da instância de destino.	O valor desta propriedade deve ser igual ao valor de SourceEndpoint.InstanceType.
Role	String	Não	Sim	Nome da função RAM autorizada pela conta Alibaba Cloud à qual a instância de destino pertence. Esta propriedade entra em vigor quando a instância de origem é uma instância ApsaraDB RDS e as instâncias de origem e destino pertencem a contas Alibaba Cloud diferentes.	Nenhuma.

Sintaxe de MigrationObject

"MigrationObject": [
  {
    "TableExcludes": List,
    "NewSchemaName": String,
    "NewDBName": String,
    "TableIncludes": List,
    "SchemaName": String,
    "DBName": String
  }
]

Propriedades de MigrationObject

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
TableExcludes	List	Não	Não	Nomes das tabelas a serem excluídas da migração do banco de dados de origem.	Exemplo: `[{"TableName": "a"}, {"TableName": "b"}, ...]`.
NewSchemaName	String	Não	Não	Nome mapeado do esquema a ser migrado para a instância de destino.	Esta propriedade está disponível quando EngineName está definido como SQLServer.
NewDBName	String	Não	Não	Nome mapeado do banco de dados a ser migrado para a instância de destino.	Esta propriedade não está disponível quando EngineName está definido como SQLServer.
TableIncludes	List	Não	Não	Nomes das tabelas a serem migradas do banco de dados de origem.	Nenhuma.
SchemaName	String	Não	Não	Nome do esquema a ser migrado.	Esta propriedade está disponível quando EngineName está definido como SQLServer.
DBName	String	Não	Não	Nome do banco de dados a ser migrado.	Esta propriedade não está disponível quando EngineName está definido como SQLServer. Se você especificar apenas a propriedade DBName e deixar as demais propriedades desta tabela vazias, o sistema migrará todos os objetos contidos no banco de dados. Se você especificar a propriedade DBName e outras propriedades nesta tabela, o sistema migrará por padrão apenas os objetos correspondentes às propriedades especificadas.

Sintaxe de TableIncludes

"TableIncludes": [
  {
    "ColumnExcludes": List,
    "FilterCondition": String,
    "NewTableName": String,
    "TableName": String,
    "ColumnIncludes": List
  }
]

Propriedades de TableIncludes

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
ColumnExcludes	List	Não	Não	Nomes das colunas a serem excluídas da migração do banco de dados de origem.	Exemplo: `[{"ColumnName": "a"}, {"ColumnName": "b"}, ...]shou'xia`.
FilterCondition	String	Não	Não	Condição de filtro.	Nenhuma.
NewTableName	String	Não	Não	Nome mapeado da tabela a ser migrada para a instância de destino.	Nenhuma.
TableName	String	Não	Não	Nome da tabela a ser migrada.	Nenhuma.
ColumnIncludes	List	Não	Não	Nomes das colunas a serem migradas da tabela de origem.	Nenhuma.

Sintaxe de ColumnIncludes

"ColumnIncludes": [
  {
    "ColumnName": String,
    "NewColumnName": String
  }
]

Propriedades de ColumnIncludes

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
ColumnName	String	Não	Não	Nome da coluna a ser migrada da tabela de origem.	Nenhuma.
NewColumnName	String	Não	Não	Nome mapeado da coluna a ser migrada para a instância de destino.	Nenhuma.

Sintaxe de ColumnExcludes

"ColumnExcludes": [
  {
    "ColumnName": String
  }
]

Propriedade de ColumnExcludes

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
ColumnName	String	Não	Não	Nome da coluna a ser excluída da migração da tabela de origem.	Nenhuma.

Sintaxe de TableExcludes

"TableExcludes": [
  {
    "TableName": String
  }
]

Propriedade de TableExcludes

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
TableName	String	Não	Não	Nome da tabela a ser excluída da migração do banco de dados de origem.	Nenhuma.

Valores de retorno

Fn::GetAtt

MigrationJobId: o ID da tarefa de migração de dados.

Exemplos

Formato YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RdsInstanceId:
    Type: String
    AssociationProperty: ALIYUN::RDS::Instance::InstanceId
Resources:
  MigrationJob:
    Type: ALIYUN::DTS::MigrationJob
    Properties:
      MigrationJobClass: small
      MigrationJobName:
        Ref: ALIYUN::StackName
      MigrationMode:
        StructureIntialization: true
        DataSynchronization: true
        DataIntialization: true
      SourceEndpoint:
        UserName: admin
        InstanceID:
          Ref: RdsInstanceId
        Region:
          Ref: ALIYUN::Region
        InstanceType: RDS
        Password: Admin@123
        Port: '3306'
      DestinationEndpoint:
        EngineName: MySQL
        Port: '3306'
        Region:
          Ref: ALIYUN::Region
        InstanceID:
          Ref: RdsInstanceId
        Password: Admin@123
        UserName: admin
        InstanceType: RDS
      MigrationObject:
        - DBName: MySQLDataBase
Outputs:
  MigrationJobId:
    Description: Migration tasks task ID
    Value:
      Fn::GetAtt:
        - MigrationJob
        - MigrationJobId

Formato JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RdsInstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId"
    }
  },
  "Resources": {
    "MigrationJob": {
      "Type": "ALIYUN::DTS::MigrationJob",
      "Properties": {
        "MigrationJobClass": "small",
        "MigrationJobName": {
          "Ref": "ALIYUN::StackName"
        },
        "MigrationMode": {
          "StructureIntialization": true,
          "DataSynchronization": true,
          "DataIntialization": true
        },
        "SourceEndpoint": {
          "UserName": "admin",
          "InstanceID": {
            "Ref": "RdsInstanceId"
          },
          "Region": {
            "Ref": "ALIYUN::Region"
          },
          "InstanceType": "RDS",
          "Password": "Admin@123",
          "Port": "3306"
        },
        "DestinationEndpoint": {
          "EngineName": "MySQL",
          "Port": "3306",
          "Region": {
            "Ref": "ALIYUN::Region"
          },
          "InstanceID": {
            "Ref": "RdsInstanceId"
          },
          "Password": "Admin@123",
          "UserName": "admin",
          "InstanceType": "RDS"
        },
        "MigrationObject": [
          {
            "DBName": "MySQLDataBase"
          }
        ]
      }
    }
  },
  "Outputs": {
    "MigrationJobId": {
      "Description": "Migration tasks task ID",
      "Value": {
        "Fn::GetAtt": [
          "MigrationJob",
          "MigrationJobId"
        ]
      }
    }
  }
}