ALIYUN::VPC::TrafficQosQueue-Resource Orchestration Service(ROS)-阿里云帮助中心

Syntax

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

Properties

Parameter	Type	Required	Update allowed	Description	Constraints
QosId	String	Yes	No	The QoS policy ID.	None
QueueType	String	Yes	No	The type of the QoS queue.	Valid values: High: a high-priority queue. Medium: a medium-priority queue. Default: a default-priority queue.
BandwidthPercent	String	No	Yes	The bandwidth percentage of the QoS queue.	Valid values: This parameter is required if `QueueType` is set to Medium. Valid values: 1 to 100. If `QueueType` is set to Default, the value of this parameter is "-".
QueueDescription	String	No	Yes	The description of the QoS queue.	The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.
QueueName	String	No	Yes	The name of the QoS queue.	The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.

Return values

Fn::GetAtt

QueueId: The ID of the QoS queue.
QosId: The ID of the QoS policy.
BandwidthPercent: The bandwidth percentage of the QoS queue.
QueueDescription: The description of the QoS queue.
QueueName: The name of the QoS queue.
QueueType: The type of the QoS queue.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  QueueDescription:
    Type: String
    Description:
      en: |-
        The description of the QoS queue.
        The description must be 0 to 256 characters in length and cannot start with 'http://' or 'https://'.
    MinLength: 0
    MaxLength: 256
    Default: Null
    Required: false
  BandwidthPercent:
    Type: String
    Description:
      en: |-
        The bandwidth percentage of the QoS queue.
        * If QueueType is **Medium**, this parameter is required. Valid values: 1 to 100.
        * If QueueType is **Default**, the value of this parameter is "-".
    Default: Null
    Required: false
  QueueType:
    Type: String
    Description:
      en: |-
        The type of the QoS queue. Valid values:
        - **High**: a high-priority queue.
        - **Medium**: a medium-priority queue.
        - **Default**: a default-priority queue.
        > Note: You cannot create a default-priority queue.
    AllowedValues:
      - High
      - Medium
      - Default
    Required: true
  QosId:
    Type: String
    Description:
      en: The QoS policy ID.
    Required: true
  QueueName:
    Type: String
    Description:
      en: |-
        The name of the QoS queue.
        The name must be 0 to 128 characters in length 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: The type of the QoS queue.
  QueueDescription:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueueDescription
    Description: The description of the QoS queue.
  QosId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QosId
    Description: The QoS policy ID.
  BandwidthPercent:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - BandwidthPercent
    Description: The bandwidth percentage of the QoS queue.
  QueueName:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueueName
    Description: The name of the QoS queue.

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "QueueDescription": {
      "Type": "String",
      "Description": {
        "en": "The description of the QoS queue.\nThe description must be 0 to 256 characters in length and cannot start with 'http://' or 'https://'."
      },
      "MinLength": 0,
      "MaxLength": 256,
      "Default": null,
      "Required": false
    },
    "BandwidthPercent": {
      "Type": "String",
      "Description": {
        "en": "The bandwidth percentage of the QoS queue.\n* If QueueType is **Medium**, this parameter is required. Valid values: 1 to 100.\n* If QueueType is **Default**, the value of this parameter is \"-\"."
      },
      "Default": null,
      "Required": false
    },
    "QueueType": {
      "Type": "String",
      "Description": {
        "en": "The type of the QoS queue. Valid values:\n- **High**: a high-priority queue.\n- **Medium**: a medium-priority queue.\n- **Default**: a default-priority queue.\n> Note: You cannot create a default-priority queue."
      },
      "AllowedValues": [
        "High",
        "Medium",
        "Default"
      ],
      "Required": true
    },
    "QosId": {
      "Type": "String",
      "Description": {
        "en": "The QoS policy ID."
      },
      "Required": true
    },
    "QueueName": {
      "Type": "String",
      "Description": {
        "en": "The name of the QoS queue.\nThe name must be 0 to 128 characters in length 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": "The type of the QoS queue."
    },
    "QueueDescription": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueueDescription"
        ]
      },
      "Description": "The description of the QoS queue."
    },
    "QosId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QosId"
        ]
      },
      "Description": "The QoS policy ID."
    },
    "BandwidthPercent": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BandwidthPercent"
        ]
      },
      "Description": "The bandwidth percentage of the QoS queue."
    },
    "QueueName": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueueName"
        ]
      },
      "Description": "The name of the QoS queue."
    }
  }
}