ALIYUN::DTS::SubscriptionInstance ROS resource type for DTS change tracking - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

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

Propriedades

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
Configuration	Map	Não	Sim	Configurações da instância de rastreamento de alterações.	Propriedades de Configuration.
SourceEndpointInstanceType	String	Não	Não	Tipo da instância de rastreamento de alterações.	Valores válidos: MySQL (padrão) PolarDB DRDS Oracle
Period	String	Não	Não	Unidade de tempo da duração da assinatura.	Valores válidos: Year Month Nota Obrigatório quando PayType estiver definido como Prepaid.
PayType	String	Não	Não	Método de faturamento.	Valores válidos: Postpaid (padrão) Prepaid
UsedTime	Integer	Não	Não	Duração da assinatura.	Valores válidos com Period definido como Year: 1 a 5. Valores válidos com Period definido como Month: 1 a 60. Nota Obrigatório quando PayType estiver definido como Prepaid.
Tags	List	Não	Sim	Tags para adicionar à instância de rastreamento de alterações.	Propriedades de Tags.

Sintaxe de Tags

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

Propriedades de Tags

Propriedade

Tipo

Obrigatório

Editável

Descrição

Restrição

Key

String

Sim

Não

Chave da tag.

Deve ter de 1 a 128 caracteres

Não pode conter http:// ou https://. Não pode começar com aliyun ou acs:.

Value

String

Não

Valor da tag.

Pode ter até 128 caracteres

Não pode conter http:// ou https://. Não pode começar com aliyun ou acs:.

Sintaxe de Configuration

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

Propriedades de Configuration

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
SubscriptionDataType	Map	Sim	Não	Tipo de dados a rastrear.	Propriedades de SubscriptionDataType.
SubscriptionInstanceName	String	Não	Não	Nome da instância de rastreamento de alterações.	Nenhuma.
SubscriptionInstance	Map	Não	Não	Configurações de rede da instância de rastreamento de alterações.	Propriedades de SubscriptionInstance.
SourceEndpoint	Map	Sim	Sim	Informações de conexão da instância de source.	Propriedades de SourceEndpoint.
SubscriptionInstanceNetworkType	String	Não	Não	Tipo de rede da instância de rastreamento de alterações.	Valores válidos: `classic`: rede clássica `vpc`: VPC
DbList	Map	Não	Não	Objetos a rastrear.	Objetos de tarefas do DTS.

Sintaxe de TableIncludes

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

Propriedade de TableIncludes

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
TableName	String	Não	Não	Nome da tabela a rastrear.	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 excluir do rastreamento de alterações no banco de dados de source.	Nenhuma.

Sintaxe de SubscriptionDataType

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

Propriedades de SubscriptionDataType

Propriedade

Tipo

Obrigatório

Editável

Descrição

Restrição

DML

Boolean

Sim

Não

Indica se deve rastrear alterações de instruções DML.

Valores válidos:

true
false

DDL

Boolean

Sim

Não

Indica se deve rastrear alterações de instruções DDL.

Valores válidos:

true
false

Sintaxe de SubscriptionInstance

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

Propriedades de SubscriptionInstance

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
VPCId	String	Sim	Não	ID da VPC da instância de rastreamento de alterações.	Aplicável apenas quando SubscriptionInstanceNetworkType estiver definido como `vpc`.
VSwitchId	String	Sim	Não	ID do vSwitch da instância de rastreamento de alterações.	Aplicável apenas quando SubscriptionInstanceNetworkType estiver definido como `vpc`.

Sintaxe de SourceEndpoint

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

Propriedades de SourceEndpoint

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
Role	String	Não	Não	Função do RAM atribuída pela conta da Alibaba Cloud da instância ApsaraDB RDS de source à conta da Alibaba Cloud da instância de destino. Aplicável quando as instâncias de source e destino pertencem a contas diferentes da Alibaba Cloud.	Nenhuma.
OracleSID	String	Não	Não	Nome da instância Oracle de source. Aplicável quando o mecanismo da instância de source é Oracle.	Nenhuma.
UserName	String	Sim	Não	Nome de usuário para acessar o banco de dados de source.	Nenhuma.
OwnerID	String	Não	Não	ID da conta da Alibaba Cloud proprietária da instância ApsaraDB RDS de source. Aplicável quando as instâncias de source e destino pertencem a contas diferentes da Alibaba Cloud.	Nenhuma.
InstanceID	String	Não	Não	ID da instância de source.	Nenhuma.
IP	String	Não	Não	Endereço IP da instância de source.	Obrigatório quando a instância de source é um banco de dados autogerenciado.
Port	String	Não	Não	Número da porta da instância de source.	Obrigatório quando a instância de source é um banco de dados autogerenciado.
DatabaseName	String	Não	Não	Nome do banco de dados para conexão.	Nenhuma.
InstanceType	String	Sim	Não	Tipo da instância de source.	Valores válidos: RDS: instância ApsaraDB RDS ECS: banco de dados autogerenciado hospedado em uma instância ECS
Password	String	Sim	Sim	Senha para fazer login na instância de source.	Nenhuma.

Valores de retorno

Fn::GetAtt

SubscriptionInstanceId: ID da instância de rastreamento de alterações.
VPCHost: endpoint da VPC da instância de rastreamento de alterações.
PublicHost: endpoint público da instância de rastreamento de alterações.
PrivateHost: endpoint privado da instância de rastreamento de alterações.
SubscribeTopic: tópico da instância de rastreamento de alterações.

Exemplos

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"
        ]
      }
    }
  }
}