ALIYUN::DTS::SynchronizationJob - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

ALIYUN::DTS::SynchronizationJob adquiere una instancia de sincronización de datos y configura una tarea de sincronización.

Nota

Utilice ALIYUN::DTS::Instance para adquirir una instancia de DTS y ALIYUN::DTS::SynchronizationJob2 para configurar la tarea de sincronización de datos.

Sintaxis

{
  "Type": "ALIYUN::DTS::SynchronizationJob",
  "Properties": {
    "SynchronizationJobClass": String,
    "SourceEndpoint": Map,
    "PayType": String,
    "DataInitialization": Boolean,
    "Period": String,
    "DestRegion": String,
    "SourceRegion": String,
    "UsedTime": Integer,
    "SynchronizationObjects": List,
    "NetworkType": String,
    "DestinationEndpoint": Map,
    "StructureInitialization": Boolean,
    "Topology": String
  }
}

Propiedades

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
SynchronizationJobClass	String	Sí	No	Especificación de la instancia.	Valores válidos: micro small (predeterminado) medium large
SourceEndpoint	Map	Sí	No	Configuración de la instancia de origen.	SourceEndpoint properties.
PayType	String	No	No	Método de facturación.	Valores válidos: Postpaid Prepaid
DataInitialization	Boolean	No	No	Indica si se debe ejecutar la sincronización inicial completa de datos.	Valores válidos: true (predeterminado) false
Period	String	No	No	Unidad de duración de la suscripción.	Valores válidos: Year Month Esta propiedad surte efecto cuando PayType se establece en Prepaid.
DestRegion	String	Sí	No	ID de región de la instancia de destino.	Ninguna.
SourceRegion	String	Sí	No	ID de región de la instancia de origen.	Ninguna.
UsedTime	Integer	No	No	Duración de la suscripción.	Esta propiedad surte efecto cuando PayType se establece en Prepaid.
SynchronizationObjects	List	No	No	Objetos por sincronizar.	SynchronizationObjects properties.
NetworkType	String	No	No	Tipo de red para la sincronización entre regiones.	Valores válidos: Internet (predeterminado) Intranet
DestinationEndpoint	Map	Sí	No	Configuración de la instancia de destino.	DestinationEndpoint properties.
StructureInitialization	Boolean	No	No	Indica si se debe ejecutar la sincronización inicial del esquema.	Valores válidos: true (predeterminado) false
Topology	String	No	No	Topología de sincronización.	Valores válidos: oneway (predeterminado) bidirectional Establezca este valor en bidirectional únicamente para sincronizaciones de MySQL a MySQL.

Sintaxis de SourceEndpoint

"SourceEndpoint": {
  "UserName": String,
  "InstanceId": String,
  "IP": String,
  "Port": String,
  "Role": String,
  "OwnerID": String,
  "Password": String,
  "InstanceType": String,
  "InstanceTypeForCreation": String
}

Propiedades de SourceEndpoint

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
UserName	String	No	No	Nombre de usuario de la instancia de origen.	Obligatorio cuando la instancia de origen es una instancia ECS o una base de datos local conectada mediante Express Connect. No es necesario para instancias de ApsaraDB for Redis.
InstanceId	String	No	No	ID de la instancia de origen.	Ninguna.
IP	String	No	No	Dirección IP de la instancia de origen.	Obligatorio cuando la instancia de origen es una base de datos local conectada mediante Express Connect.
Port	String	No	No	Puerto de escucha de la instancia de origen.	Obligatorio cuando la instancia de origen es una instancia ECS o una base de datos local conectada mediante Express Connect.
Role	String	No	No	Rol de RAM autorizado por la cuenta de Alibaba Cloud propietaria de la instancia de origen. Obligatorio cuando las instancias de origen y destino pertenecen a diferentes cuentas de Alibaba Cloud. Para obtener detalles sobre permisos y autorización, consulte Configure RAM authorization for cross-account DTS tasks.	Ninguna.
OwnerID	String	No	No	ID de la cuenta de Alibaba Cloud propietaria de la instancia de origen. Obligatorio cuando las instancias de origen y destino pertenecen a diferentes cuentas de Alibaba Cloud.	Ninguna.
Password	String	No	No	Contraseña de la instancia de origen.	Obligatorio cuando la instancia de origen es una instancia ECS o una base de datos local conectada mediante Express Connect.
InstanceType	String	Sí	No	Tipo de la instancia de origen.	Valores válidos: Redis: Instancia de ApsaraDB for Redis RDS: Instancia de ApsaraDB RDS POLARDB: Clúster de PolarDB for MySQL ECS: Base de datos autogestionada alojada en una instancia ECS Express: Base de datos autogestionada conectada mediante un circuito de Express Connect dg: Base de datos autogestionada conectada mediante Database Gateway (DG) cen: Base de datos autogestionada conectada mediante Cloud Enterprise Network (CEN)
InstanceTypeForCreation	String	No	No	Tipo de la instancia de origen para el canal de sincronización.	Valores válidos: MySQL PolarDB Redis SQLServer PostgreSQL PolarDB-X (anteriormente conocido como DRDS)

Sintaxis de SynchronizationObjects

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

Propiedades de SynchronizationObjects

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
TableExcludes	List	No	No	Tablas por excluir de la sincronización.	Ninguna.
NewSchemaName	String	No	No	Nombre del esquema asignado en la instancia de destino.	Ninguna.
NewDBName	String	No	No	Nombre de la base de datos asignado en la instancia de destino.	Ninguna.
TableIncludes	List	No	No	Tablas por sincronizar desde la base de datos de origen.	Ninguna.
SchemaName	String	No	No	Nombre del esquema por sincronizar.	Ninguna.
DBName	String	No	No	Nombre de la base de datos por sincronizar.	Ninguna.

Sintaxis de TableExcludes

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

Propiedad de TableExcludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
TableName	String	No	No	Nombre de la tabla.	Ninguna.

Sintaxis de TableIncludes

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

Propiedades de TableIncludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
TableName	String	No	No	Nombre de la tabla por sincronizar.	Ninguna.
FilterCondition	String	No	No	Condición de filtro.	Ninguna.
ColumnExcludes	List	No	No	Columnas por excluir de la sincronización.	Ninguna.
ColumnIncludes	List	No	No	Columnas por sincronizar.	Ninguna.
NewTableName	String	No	No	Nombre de la tabla asignado en la instancia de destino.	Ninguna.

Sintaxis de ColumnExcludes

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

Propiedad de ColumnExcludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
ColumnName	String	No	No	Nombre de la columna por excluir de la sincronización.	Ninguna.

Sintaxis de ColumnIncludes

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

Propiedades de ColumnIncludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
NewColumnName	String	No	No	Nombre de la columna asignado en la instancia de destino.	Ninguna.
ColumnName	String	No	No	Nombre de la columna por sincronizar.	Ninguna.

Sintaxis de DestinationEndpoint

"DestinationEndpoint": {
  "UserName": String,
  "InstanceId": String,
  "IP": String,
  "InstanceType": String,
  "Password": String,
  "InstanceTypeForCreation": String,
  "Port": String
}

Propiedades de DestinationEndpoint

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
UserName	String	No	No	Nombre de usuario de la instancia de destino.	Obligatorio cuando la instancia de destino es una instancia ECS o una base de datos local conectada mediante Express Connect. No es necesario para instancias de ApsaraDB for Redis.
InstanceId	String	No	No	ID de la instancia de destino.	Para destinos MaxCompute, establezca el nombre del proyecto de MaxCompute. Para destinos AnalyticDB for MySQL, establezca el ID del clúster. Para destinos DataHub, establezca el nombre del proyecto de DataHub.
IP	String	No	No	Dirección IP de la instancia de destino.	Obligatorio cuando la instancia de destino es una base de datos local conectada mediante Express Connect.
InstanceType	String	Sí	No	Tipo de la instancia de destino.	Valores válidos: Redis: Instancia de ApsaraDB for Redis RDS (predeterminado): Instancia de ApsaraDB RDS POLARDB: Clúster de PolarDB for MySQL ECS: Base de datos autogestionada alojada en una instancia ECS Express: Base de datos autogestionada conectada mediante un circuito de Express Connect MaxCompute: Proyecto de MaxCompute DataHub: Proyecto de DataHub AnalyticDB: Clúster de AnalyticDB for MySQL V2.0 AnalyticDB30: Clúster de AnalyticDB for MySQL V3.0
InstanceTypeForCreation	String	No	No	Tipo de la instancia de destino para el canal de sincronización.	Valores válidos: MySQL PolarDB Redis MaxCompute DataHub Kafka Elasticsearch Tablestore
Password	String	No	No	Contraseña de la instancia de destino.	Obligatorio cuando la instancia de destino es una instancia ECS o una base de datos local conectada mediante Express Connect.
Port	String	No	No	Puerto de escucha de la instancia de destino.	Obligatorio cuando la instancia de destino es una instancia ECS o una base de datos local conectada mediante Express Connect.

Valores de retorno

Fn::GetAtt

SynchronizationJobId: ID de la instancia de sincronización de datos.

Ejemplos

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RdsId:
    Type: String
    AssociationProperty: ALIYUN::RDS::Instance::InstanceId
Resources:
  SynchronizationJob:
    Type: ALIYUN::DTS::SynchronizationJob
    Properties:
      SynchronizationJobClass: small
      SourceEndpoint:
        InstanceId:
          Ref: RdsId
        InstanceTypeForCreation: MySQL
        InstanceType: RDS
      PayType: Postpaid
      DataInitialization: false
      DestRegion:
        Ref: ALIYUN::Region
      SourceRegion:
        Ref: ALIYUN::Region
      NetworkType: Internet
      DestinationEndpoint:
        InstanceId:
          Ref: RdsId
        InstanceTypeForCreation: MySQL
        InstanceType: RDS
      StructureInitialization: false
Outputs:
  SynchronizationJobId:
    Description: Synchronization instance ID
    Value:
      Fn::GetAtt:
        - SynchronizationJob
        - SynchronizationJobId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RdsId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId"
    }
  },
  "Resources": {
    "SynchronizationJob": {
      "Type": "ALIYUN::DTS::SynchronizationJob",
      "Properties": {
        "SynchronizationJobClass": "small",
        "SourceEndpoint": {
          "InstanceId": {
            "Ref": "RdsId"
          },
          "InstanceTypeForCreation": "MySQL",
          "InstanceType": "RDS"
        },
        "PayType": "Postpaid",
        "DataInitialization": false,
        "DestRegion": {
          "Ref": "ALIYUN::Region"
        },
        "SourceRegion": {
          "Ref": "ALIYUN::Region"
        },
        "NetworkType": "Internet",
        "DestinationEndpoint": {
          "InstanceId": {
            "Ref": "RdsId"
          },
          "InstanceTypeForCreation": "MySQL",
          "InstanceType": "RDS"
        },
        "StructureInitialization": false
      }
    }
  },
  "Outputs": {
    "SynchronizationJobId": {
      "Description": "Synchronization instance ID",
      "Value": {
        "Fn::GetAtt": [
          "SynchronizationJob",
          "SynchronizationJobId"
        ]
      }
    }
  }
}