ALIYUN::DTS::ConsumerChannel-资源编排(ROS)-阿里云帮助中心

语法

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

属性

属性名称	类型	必须	允许更新	描述	约束
ConsumerGroupName	String	是	是	消费组名称。	最长128个字符。
ConsumerGroupPassword	String	是	是	消费组密码。	由大写字母、小写字母、数字和特殊字符组成（至少包含两种类型），长度为8-32个字符。
ConsumerGroupUserName	String	是	否	用户名。	由大写字母、小写字母、数字和下划线组成，最长16个字符。
DtsInstanceId	String	否	否	DTS订阅实例ID。	DtsInstanceId或DtsJobId必须提供一个。
DtsJobId	String	否	否	DTS订阅任务ID。	DtsInstanceId或DtsJobId必须提供一个。

返回值

Fn::GetAtt

ConsumerGroupId：消费组ID
DtsJobId：DTS任务ID
ConsumerGroupUserName：消费组用户名
ConsumerGroupName：消费组名称
DtsInstanceId：DTS实例ID

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ConsumerGroupUserName:
    Type: String
    Description:
      en: Username, composed of uppercase letters, lowercase letters, numbers, and underscores, up to 16 characters.
    Required: true
  DtsInstanceId:
    Type: String
    Description:
      en: DTS subscription instance ID. Either DtsInstanceId or DtsJobId must be provided.
    Default: Null
    Required: false
  DtsJobId:
    Type: String
    Description:
      en: DTS subscription job ID. Either DtsInstanceId or DtsJobId must be provided.
    Default: Null
    Required: false
  ConsumerGroupName:
    Type: String
    Description:
      en: Consumer group name, up to 128 characters.
    Required: true
  ConsumerGroupPassword:
    Type: String
    Description:
      en: Consumer group password, composed of uppercase letters, lowercase letters, numbers, and special characters (at least two types), 8-32 characters long.
    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: Consumer group ID
  ConsumerGroupName:
    Value:
      Fn::GetAtt:
        - ConsumerChannel
        - ConsumerGroupName
    Description: Consumer group name
  ConsumerGroupUserName:
    Value:
      Fn::GetAtt:
        - ConsumerChannel
        - ConsumerGroupUserName
    Description: Consumer group username
  DtsInstanceId:
    Value:
      Fn::GetAtt:
        - ConsumerChannel
        - DtsInstanceId
    Description: DTS instance ID
  DtsJobId:
    Value:
      Fn::GetAtt:
        - ConsumerChannel
        - DtsJobId
    Description: DTS job ID

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ConsumerGroupUserName": {
      "Type": "String",
      "Description": {
        "en": "Username, composed of uppercase letters, lowercase letters, numbers, and underscores, up to 16 characters."
      },
      "Required": true
    },
    "DtsInstanceId": {
      "Type": "String",
      "Description": {
        "en": "DTS subscription instance ID. Either DtsInstanceId or DtsJobId must be provided."
      },
      "Default": null,
      "Required": false
    },
    "DtsJobId": {
      "Type": "String",
      "Description": {
        "en": "DTS subscription job ID. Either DtsInstanceId or DtsJobId must be provided."
      },
      "Default": null,
      "Required": false
    },
    "ConsumerGroupName": {
      "Type": "String",
      "Description": {
        "en": "Consumer group name, up to 128 characters."
      },
      "Required": true
    },
    "ConsumerGroupPassword": {
      "Type": "String",
      "Description": {
        "en": "Consumer group password, composed of uppercase letters, lowercase letters, numbers, and special characters (at least two types), 8-32 characters long."
      },
      "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": "Consumer group ID"
    },
    "ConsumerGroupName": {
      "Value": {
        "Fn::GetAtt": [
          "ConsumerChannel",
          "ConsumerGroupName"
        ]
      },
      "Description": "Consumer group name"
    },
    "ConsumerGroupUserName": {
      "Value": {
        "Fn::GetAtt": [
          "ConsumerChannel",
          "ConsumerGroupUserName"
        ]
      },
      "Description": "Consumer group username"
    },
    "DtsInstanceId": {
      "Value": {
        "Fn::GetAtt": [
          "ConsumerChannel",
          "DtsInstanceId"
        ]
      },
      "Description": "DTS instance ID"
    },
    "DtsJobId": {
      "Value": {
        "Fn::GetAtt": [
          "ConsumerChannel",
          "DtsJobId"
        ]
      },
      "Description": "DTS job ID"
    }
  }
}