ALIYUN::DTS::SubscriptionInstance ROS resource type for DTS change tracking - Resource Orchestration Service

ALIYUN::DTS::SubscriptionInstance crea una instancia de seguimiento de cambios de Data Transmission Service (DTS) y configura una tarea de seguimiento de cambios.

Nota

Se recomienda utilizar ALIYUN::DTS::Instance para adquirir una instancia de DTS y ALIYUN::DTS::SubscriptionJob2 para configurar una tarea de seguimiento de cambios.

Sintaxis

{
  "Type": "ALIYUN::DTS::SubscriptionInstance",
  "Properties": {
    "Configuration": Map,
    "SourceEndpointInstanceType": String,
    "Period": String,
    "PayType": String,
    "UsedTime": Integer,
    "Tags": List
  }
}

Propiedades

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
Configuration	Map	No	Sí	Las configuraciones de la instancia de seguimiento de cambios.	Configuration properties.
SourceEndpointInstanceType	String	No	No	El tipo de la instancia de seguimiento de cambios.	Valores válidos: MySQL (predeterminado) PolarDB DRDS Oracle
Period	String	No	No	La unidad de duración de la suscripción.	Valores válidos: Year Month Nota Obligatorio cuando PayType se establece en Prepaid.
PayType	String	No	No	El método de facturación.	Valores válidos: Postpaid (predeterminado) Prepaid
UsedTime	Integer	No	No	La duración de la suscripción.	Valores válidos cuando Period se establece en Year: 1 a 5. Valores válidos cuando Period se establece en Month: 1 a 60. Nota Obligatorio cuando PayType se establece en Prepaid.
Tags	List	No	Sí	Las etiquetas que se agregarán a la instancia de seguimiento de cambios.	Tags properties.

Sintaxis de Tags

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Propiedades de Tags

Propiedad

Tipo

Obligatorio

Editable

Descripción

Restricción

Key

String

Sí

La clave de la etiqueta.

Debe tener entre 1 y 128 caracteres de longitud

No puede contener http:// ni https://. No puede comenzar con aliyun ni acs:.

Value

String

El valor de la etiqueta.

Puede tener hasta 128 caracteres de longitud

No puede contener http:// ni https://. No puede comenzar con aliyun ni acs:.

Sintaxis de Configuration

"Configuration": {
  "SubscriptionDataType": Map,
  "SubscriptionInstanceName": String,
  "SubscriptionInstance": Map,
  "SourceEndpoint": Map,
  "SubscriptionInstanceNetworkType": String,
  "DbList": Map
}

Propiedades de Configuration

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
SubscriptionDataType	Map	Sí	No	El tipo de datos a rastrear.	SubscriptionDataType properties.
SubscriptionInstanceName	String	No	No	El nombre de la instancia de seguimiento de cambios.	Ninguna.
SubscriptionInstance	Map	No	No	Las configuraciones de red de la instancia de seguimiento de cambios.	SubscriptionInstance properties.
SourceEndpoint	Map	Sí	Sí	La información de conexión de la instancia de origen.	SourceEndpoint properties.
SubscriptionInstanceNetworkType	String	No	No	El tipo de red de la instancia de seguimiento de cambios.	Valores válidos: `classic`: red clásica `vpc`: VPC
DbList	Map	No	No	Los objetos a rastrear.	Objects of DTS tasks.

Sintaxis de TableIncludes

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

Propiedad de TableIncludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
TableName	String	No	No	El nombre de la tabla a rastrear.	Ninguna.

Sintaxis de TableExcludes

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

Propiedad de TableExcludes

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
TableName	String	No	No	El nombre de la tabla que se excluirá del seguimiento de cambios en la base de datos de origen.	Ninguna.

Sintaxis de SubscriptionDataType

"SubscriptionDataType": {
  "DML": Boolean,
  "DDL": Boolean
}

Propiedades de SubscriptionDataType

Propiedad

Tipo

Obligatorio

Editable

Descripción

Restricción

DML

Boolean

Sí

Especifica si se deben rastrear los cambios en sentencias DML.

Valores válidos:

true
false

DDL

Boolean

Sí

Especifica si se deben rastrear los cambios en sentencias DDL.

Valores válidos:

true
false

Sintaxis de SubscriptionInstance

"SubscriptionInstance": {
  "VPCId": String,
  "VSwitchId": String
}

Propiedades de SubscriptionInstance

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
VPCId	String	Sí	No	El ID de VPC de la instancia de seguimiento de cambios.	Solo tiene efecto cuando SubscriptionInstanceNetworkType se establece en `vpc`.
VSwitchId	String	Sí	No	El ID de vSwitch de la instancia de seguimiento de cambios.	Solo tiene efecto cuando SubscriptionInstanceNetworkType se establece en `vpc`.

Sintaxis de SourceEndpoint

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

Propiedades de SourceEndpoint

Propiedad	Tipo	Obligatorio	Editable	Descripción	Restricción
Role	String	No	No	El rol de RAM que la cuenta de Alibaba Cloud de la instancia de ApsaraDB RDS de origen asigna a la cuenta de Alibaba Cloud de la instancia de destino. Tiene efecto cuando las instancias de origen y destino pertenecen a diferentes cuentas de Alibaba Cloud.	Ninguna.
OracleSID	String	No	No	El nombre de la instancia Oracle de origen. Tiene efecto cuando el motor de la instancia de origen es Oracle.	Ninguna.
UserName	String	Sí	No	El nombre de usuario utilizado para acceder a la base de datos de origen.	Ninguna.
OwnerID	String	No	No	El ID de la cuenta de Alibaba Cloud del propietario de la instancia de ApsaraDB RDS de origen. Tiene efecto cuando las instancias de origen y destino pertenecen a diferentes cuentas de Alibaba Cloud.	Ninguna.
InstanceID	String	No	No	El ID de la instancia de origen.	Ninguna.
IP	String	No	No	La dirección IP de la instancia de origen.	Obligatorio cuando la instancia de origen es una base de datos autogestionada.
Port	String	No	No	El número de puerto de la instancia de origen.	Obligatorio cuando la instancia de origen es una base de datos autogestionada.
DatabaseName	String	No	No	El nombre de la base de datos para la conexión.	Ninguna.
InstanceType	String	Sí	No	El tipo de la instancia de origen.	Valores válidos: RDS: instancia de ApsaraDB RDS ECS: base de datos autogestionada alojada en una instancia de ECS
Password	String	Sí	Sí	La contraseña utilizada para iniciar sesión en la instancia de origen.	Ninguna.

Valores de retorno

Fn::GetAtt

SubscriptionInstanceId: el ID de la instancia de seguimiento de cambios.
VPCHost: el endpoint de VPC de la instancia de seguimiento de cambios.
PublicHost: el endpoint público de la instancia de seguimiento de cambios.
PrivateHost: el endpoint privado de la instancia de seguimiento de cambios.
SubscribeTopic: el tema de la instancia de seguimiento de cambios.

Ejemplos

Formato YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
  RdsId:
    Type: String
    AssociationProperty: ALIYUN::RDS::Instance::InstanceId
Resources:
  SubscriptionInstance:
    Type: ALIYUN::DTS::SubscriptionInstance
    Properties:
      SourceEndpointInstanceType: MySQL
      Configuration:
        SubscriptionObject:
          - DBName: DemoDB
        SubscriptionDataType:
          DDL: true
          DML: false
        SubscriptionInstanceName: TestSubscription
        SourceEndpoint:
          InstanceType: RDS
          UserName: DBAdmin
          Password: Admin@123!
          InstanceID:
            Ref: RdsId
        SubscriptionInstanceNetworkType: vpc
        SubscriptionInstance:
          VPCId:
            Ref: VpcId
          VSwitchId:
            Ref: VSwitchId
Outputs:
  PublicHost:
    Description: Public host.
    Value:
      Fn::GetAtt:
        - SubscriptionInstance
        - PublicHost
  PrivateHost:
    Description: Private host.
    Value:
      Fn::GetAtt:
        - SubscriptionInstance
        - PrivateHost
  SubscriptionInstanceId:
    Description: The ID of Data subscription instance.
    Value:
      Fn::GetAtt:
        - SubscriptionInstance
        - SubscriptionInstanceId
  VPCHost:
    Description: VPC host.
    Value:
      Fn::GetAtt:
        - SubscriptionInstance
        - VPCHost

Formato JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}"
      }
    },
    "RdsId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId"
    }
  },
  "Resources": {
    "SubscriptionInstance": {
      "Type": "ALIYUN::DTS::SubscriptionInstance",
      "Properties": {
        "SourceEndpointInstanceType": "MySQL",
        "Configuration": {
          "SubscriptionObject": [
            {
              "DBName": "DemoDB"
            }
          ],
          "SubscriptionDataType": {
            "DDL": true,
            "DML": false
          },
          "SubscriptionInstanceName": "TestSubscription",
          "SourceEndpoint": {
            "InstanceType": "RDS",
            "UserName": "DBAdmin",
            "Password": "Admin@123!",
            "InstanceID": {
              "Ref": "RdsId"
            }
          },
          "SubscriptionInstanceNetworkType": "vpc",
          "SubscriptionInstance": {
            "VPCId": {
              "Ref": "VpcId"
            },
            "VSwitchId": {
              "Ref": "VSwitchId"
            }
          }
        }
      }
    }
  },
  "Outputs": {
    "PublicHost": {
      "Description": "Public host.",
      "Value": {
        "Fn::GetAtt": [
          "SubscriptionInstance",
          "PublicHost"
        ]
      }
    },
    "PrivateHost": {
      "Description": "Private host.",
      "Value": {
        "Fn::GetAtt": [
          "SubscriptionInstance",
          "PrivateHost"
        ]
      }
    },
    "SubscriptionInstanceId": {
      "Description": "The ID of Data subscription instance.",
      "Value": {
        "Fn::GetAtt": [
          "SubscriptionInstance",
          "SubscriptionInstanceId"
        ]
      }
    },
    "VPCHost": {
      "Description": "VPC host.",
      "Value": {
        "Fn::GetAtt": [
          "SubscriptionInstance",
          "VPCHost"
        ]
      }
    }
  }
}