Todos os produtos
Search
Central de documentação

Resource Orchestration Service:ALIYUN::DTS::ConsumerChannel

Última atualização: Jul 05, 2026

Use o recurso ALIYUN::DTS::ConsumerChannel para criar um grupo de consumidores em uma tarefa de assinatura do Data Transmission Service (DTS). Esse grupo permite que clientes downstream consumam os dados assinados.

Sintaxe

{
  "Type": "ALIYUN::DTS::ConsumerChannel",
  "Properties": {
    "ConsumerGroupPassword": String,
    "ConsumerGroupUserName": String,
    "ConsumerGroupName": String,
    "DtsJobId": String,
    "DtsInstanceId": String
  }
}

Propriedades

Parâmetro

Tipo

Obrigatório

Atualização permitida

Descrição

Restrição

ConsumerGroupName

String

Sim

Sim

Nome do grupo de consumidores.

Até 128 caracteres.

ConsumerGroupPassword

String

Sim

Sim

Senha do grupo de consumidores.

Deve ter de 8 a 32 caracteres e incluir pelo menos dois dos seguintes tipos: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais.

ConsumerGroupUserName

String

Sim

Não

Nome de usuário do grupo de consumidores.

Até 16 caracteres, compostos por letras maiúsculas, letras minúsculas, dígitos e sublinhados (_).

DtsInstanceId

String

Não

Não

ID da instância de assinatura do DTS.

Especifique DtsInstanceId ou DtsJobId.

DtsJobId

String

Não

Não

ID da tarefa de assinatura do DTS.

Especifique DtsInstanceId ou DtsJobId.

Valores de retorno

Fn::GetAtt

  • ConsumerGroupId: ID do grupo de consumidores.

  • DtsJobId: ID da tarefa de assinatura do DTS.

  • ConsumerGroupUserName: Nome de usuário do grupo de consumidores.

  • ConsumerGroupName: Nome do grupo de consumidores.

  • DtsInstanceId: ID da instância de assinatura do DTS.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ConsumerGroupUserName:
    Type: String
    Description: The consumer group username. The value can be up to 16 characters in length and must consist of uppercase letters, lowercase letters, digits, and underscores (_).
    Required: true
  DtsInstanceId:
    Type: String
    Description: The ID of the DTS subscription instance. Specify either this property or DtsJobId.
    Default: Null
    Required: false
  DtsJobId:
    Type: String
    Description: The ID of the DTS subscription job. Specify either this property or DtsInstanceId.
    Default: Null
    Required: false
  ConsumerGroupName:
    Type: String
    Description: The consumer group name. The value can be up to 128 characters in length.
    Required: true
  ConsumerGroupPassword:
    Type: String
    Description: The consumer group password. Must be 8 to 32 characters long and include at least two of the following: uppercase letters, lowercase letters, digits, and special characters.
    Required: true
Resources:
  ConsumerChannel:
    Type: ALIYUN::DTS::ConsumerChannel
    Properties:
      ConsumerGroupUserName:
        Ref: ConsumerGroupUserName
      DtsInstanceId:
        Ref: DtsInstanceId
      DtsJobId:
        Ref: DtsJobId
      ConsumerGroupName:
        Ref: ConsumerGroupName
      ConsumerGroupPassword:
        Ref: ConsumerGroupPassword
Outputs:
  ConsumerGroupId:
    Value:
      Fn::GetAtt:
        - ConsumerChannel
        - ConsumerGroupId
    Description: The ID of the consumer group.
  ConsumerGroupName:
    Value:
      Fn::GetAtt:
        - ConsumerChannel
        - ConsumerGroupName
    Description: The name of the consumer group.
  ConsumerGroupUserName:
    Value:
      Fn::GetAtt:
        - ConsumerChannel
        - ConsumerGroupUserName
    Description: The username of the consumer group.
  DtsInstanceId:
    Value:
      Fn::GetAtt:
        - ConsumerChannel
        - DtsInstanceId
    Description: The ID of the DTS subscription instance.
  DtsJobId:
    Value:
      Fn::GetAtt:
        - ConsumerChannel
        - DtsJobId
    Description: The ID of the DTS subscription job.
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ConsumerGroupUserName": {
      "Type": "String",
      "Description": "The consumer group username. The value can be up to 16 characters in length and must consist of uppercase letters, lowercase letters, digits, and underscores (_).",
      "Required": true
    },
    "DtsInstanceId": {
      "Type": "String",
      "Description": "The ID of the DTS subscription instance. Specify either this property or DtsJobId.",
      "Default": null,
      "Required": false
    },
    "DtsJobId": {
      "Type": "String",
      "Description": "The ID of the DTS subscription job. Specify either this property or DtsInstanceId.",
      "Default": null,
      "Required": false
    },
    "ConsumerGroupName": {
      "Type": "String",
      "Description": "The consumer group name. The value can be up to 128 characters in length.",
      "Required": true
    },
    "ConsumerGroupPassword": {
      "Type": "String",
      "Description": "The consumer group password. Must be 8 to 32 characters long and include at least two of the following: uppercase letters, lowercase letters, digits, and special characters.",
      "Required": true
    }
  },
  "Resources": {
    "ConsumerChannel": {
      "Type": "ALIYUN::DTS::ConsumerChannel",
      "Properties": {
        "ConsumerGroupUserName": {
          "Ref": "ConsumerGroupUserName"
        },
        "DtsInstanceId": {
          "Ref": "DtsInstanceId"
        },
        "DtsJobId": {
          "Ref": "DtsJobId"
        },
        "ConsumerGroupName": {
          "Ref": "ConsumerGroupName"
        },
        "ConsumerGroupPassword": {
          "Ref": "ConsumerGroupPassword"
        }
      }
    }
  },
  "Outputs": {
    "ConsumerGroupId": {
      "Value": {
        "Fn::GetAtt": [
          "ConsumerChannel",
          "ConsumerGroupId"
        ]
      },
      "Description": "The ID of the consumer group."
    },
    "ConsumerGroupName": {
      "Value": {
        "Fn::GetAtt": [
          "ConsumerChannel",
          "ConsumerGroupName"
        ]
      },
      "Description": "The name of the consumer group."
    },
    "ConsumerGroupUserName": {
      "Value": {
        "Fn::GetAtt": [
          "ConsumerChannel",
          "ConsumerGroupUserName"
        ]
      },
      "Description": "The username of the consumer group."
    },
    "DtsInstanceId": {
      "Value": {
        "Fn::GetAtt": [
          "ConsumerChannel",
          "DtsInstanceId"
        ]
      },
      "Description": "The ID of the DTS subscription instance."
    },
    "DtsJobId": {
      "Value": {
        "Fn::GetAtt": [
          "ConsumerChannel",
          "DtsJobId"
        ]
      },
      "Description": "The ID of the DTS subscription job."
    }
  }
}