ALIYUN::DTS::ConsumerChannel - Resource Orchestration Service

Syntax

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

Properties

Parameter	Type	Required	Update Allowed	Description	Constraint
ConsumerGroupName	String	Yes	Yes	The consumer group name.	Up to 128 characters.
ConsumerGroupPassword	String	Yes	Yes	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.
ConsumerGroupUserName	String	Yes	No	The consumer group username.	Must be up to 16 characters long and consist of uppercase letters, lowercase letters, digits, and underscores (_).
DtsInstanceId	String	No	No	The DTS subscription instance ID.	Specify either `DtsInstanceId` or `DtsJobId`.
DtsJobId	String	No	No	The DTS subscription job ID.	Specify either `DtsInstanceId` or `DtsJobId`.

Return values

Fn::GetAtt

ConsumerGroupId: The ID of the consumer group.
DtsJobId: The ID of the DTS subscription job.
ConsumerGroupUserName: The username of the consumer group.
ConsumerGroupName: The name of the consumer group.
DtsInstanceId: The ID of the DTS subscription instance.

Examples

YAML

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.

JSON

{
  "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."
    }
  }
}