ALIYUN::VPC::TrafficQosQueue

更新时间:
复制 MD 格式

ALIYUN::VPC::TrafficQosQueue类型用于创建高速通道QoS队列。

语法

{
  "Type": "ALIYUN::VPC::TrafficQosQueue",
  "Properties": {
    "QosId": String,
    "QueueType": String,
    "BandwidthPercent": String,
    "QueueDescription": String,
    "QueueName": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

QosId

String

QoS策略ID。

QueueType

String

QoS队列类型。

取值:

  • High:高优先级队列。

  • Medium:普通优先级队列。

  • Default:默认优先级队列。

BandwidthPercent

String

QoS队列带宽百分比。

取值:

  • 当 QoS 队列类型为 Medium 的时候,此字段必须输入,取值范围为:1~100。

  • 当 QoS 队列类型为 Default 的时候,此字段为"-"。

QueueDescription

String

QoS队列的描述。

长度为0~256个字符,不能以'http://'或'https://'开头。

QueueName

String

QoS队列的名称。

长度为0~128个字符,不能以'http://'或'https://'开头。

返回值

Fn::GetAtt

  • QueueId:QoS队列ID。

  • QosId:QoS策略ID。

  • BandwidthPercent:QoS队列带宽百分比。

  • QueueDescription:QoS队列的描述。

  • QueueName:QoS队列的名称。

  • QueueType:QoS队列类型。

示例

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  QueueDescription:
    Type: String
    Description:
      en: |-
        The description of the QoS queue.
        The length is 0 to 256 characters and cannot start with 'http:// 'or 'https.
    MinLength: 0
    MaxLength: 256
    Default: Null
    Required: false
  BandwidthPercent:
    Type: String
    Description:
      en: |-
        QoS queue bandwidth percentage.
        * When the QoS queue type is **Medium**, this field must be entered. Valid values: 1 to 100.
        * When the QoS queue type is **Default**, this field is "-".
    Default: Null
    Required: false
  QueueType:
    Type: String
    Description:
      en: |-
        QoS queue type, value:
        - **High**: High priority queue.
        - **Medium**: Normal priority queue.
        - **Default**: the Default priority queue.
        > Default priority queue cannot be created.
    AllowedValues:
      - High
      - Medium
      - Default
    Required: true
  QosId:
    Type: String
    Description:
      en: The ID of the QoS policy.
    Required: true
  QueueName:
    Type: String
    Description:
      en: |-
        The name of the QoS queue.
        The length is 0 to 128 characters and cannot start with 'http:// 'or 'https.
    MinLength: 0
    MaxLength: 128
    Default: Null
    Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::VPC::TrafficQosQueue
    Properties:
      QueueDescription:
        Ref: QueueDescription
      BandwidthPercent:
        Ref: BandwidthPercent
      QueueType:
        Ref: QueueType
      QosId:
        Ref: QosId
      QueueName:
        Ref: QueueName
Outputs:
  QueueId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueueId
    Description: The ID of the QoS queue.
  QueueType:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueueType
    Description: QoS queue type.
  QueueDescription:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueueDescription
    Description: The description of the QoS queue.
  QosId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QosId
    Description: The ID of the QoS policy.
  BandwidthPercent:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - BandwidthPercent
    Description: QoS queue bandwidth percentage.
  QueueName:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueueName
    Description: The name of the QoS queue.
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "QueueDescription": {
      "Type": "String",
      "Description": {
        "en": "The description of the QoS queue.\nThe length is 0 to 256 characters and cannot start with 'http:// 'or 'https."
      },
      "MinLength": 0,
      "MaxLength": 256,
      "Default": null,
      "Required": false
    },
    "BandwidthPercent": {
      "Type": "String",
      "Description": {
        "en": "QoS queue bandwidth percentage.\n* When the QoS queue type is **Medium**, this field must be entered. Valid values: 1 to 100.\n* When the QoS queue type is **Default**, this field is \"-\"."
      },
      "Default": null,
      "Required": false
    },
    "QueueType": {
      "Type": "String",
      "Description": {
        "en": "QoS queue type, value:\n- **High**: High priority queue.\n- **Medium**: Normal priority queue.\n- **Default**: the Default priority queue.\n> Default priority queue cannot be created."
      },
      "AllowedValues": [
        "High",
        "Medium",
        "Default"
      ],
      "Required": true
    },
    "QosId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the QoS policy."
      },
      "Required": true
    },
    "QueueName": {
      "Type": "String",
      "Description": {
        "en": "The name of the QoS queue.\nThe length is 0 to 128 characters and cannot start with 'http:// 'or 'https."
      },
      "MinLength": 0,
      "MaxLength": 128,
      "Default": null,
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::TrafficQosQueue",
      "Properties": {
        "QueueDescription": {
          "Ref": "QueueDescription"
        },
        "BandwidthPercent": {
          "Ref": "BandwidthPercent"
        },
        "QueueType": {
          "Ref": "QueueType"
        },
        "QosId": {
          "Ref": "QosId"
        },
        "QueueName": {
          "Ref": "QueueName"
        }
      }
    }
  },
  "Outputs": {
    "QueueId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueueId"
        ]
      },
      "Description": "The ID of the QoS queue."
    },
    "QueueType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueueType"
        ]
      },
      "Description": "QoS queue type."
    },
    "QueueDescription": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueueDescription"
        ]
      },
      "Description": "The description of the QoS queue."
    },
    "QosId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QosId"
        ]
      },
      "Description": "The ID of the QoS policy."
    },
    "BandwidthPercent": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BandwidthPercent"
        ]
      },
      "Description": "QoS queue bandwidth percentage."
    },
    "QueueName": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueueName"
        ]
      },
      "Description": "The name of the QoS queue."
    }
  }
}