ALIYUN::VPC::TrafficQos

更新时间:
复制 MD 格式

The ALIYUN::VPC::TrafficQos resource creates a traffic QoS policy.

Syntax

{
  "Type": "ALIYUN::VPC::TrafficQos",
  "Properties": {
    "QosName": String,
    "QosDescription": String,
    "ResourceGroupId": String,
    "Tags": List
  }
}

Properties

Parameter

Type

Required

Update allowed

Description

Constraints

QosDescription

String

No

Yes

The description of the QoS policy.

The description must be 0 to 256 characters in length and cannot start with http:// or https://.

QosName

String

No

Yes

The name of the QoS policy.

The name must be 0 to 128 characters in length and cannot start with http:// or https://.

ResourceGroupId

String

No

Yes

The ID of the resource group.

None

Tags

List

No

Yes

The tags of the QoS policy.

Maximum number of tags: 20. For more information, see Tags Properties.

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Parameter

Type

Required

Update allowed

Description

Constraints

Key

String

Yes

No

The tag key.

None

Value

String

No

No

The tag value.

None

Return values

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following attributes are supported:

  • ResourceGroupId: The ID of the resource group.

  • QosId: The QoS policy ID.

  • QosName: The name of the QoS policy.

  • Tags: The tags of the QoS policy.

  • Progressing: The configuration progress of the QoS policy, ranging from 0 to 100.

  • QosDescription: The description of the QoS policy.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ResourceGroupId:
    Type: String
    Description:
      en: The ID of the resource group.
    AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
    Default: Null
    Required: false
  Tags:
    Description:
      en: The tags of the TrafficQos resource.
    Required: false
    Default: Null
    Type: Json
    MaxLength: 20
    AssociationProperty: List[Parameters]
    AssociationPropertyMetadata:
      Parameters:
        Key:
          Type: String
          Required: true
        Value:
          Type: String
          Default: Null
          Required: false
      ListMetadata:
        Order:
          - Key
          - Value
  QosName:
    Type: String
    Description:
      en: |-
        The name of the QoS policy.
        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
  QosDescription:
    Type: String
    Description:
      en: |-
        The description of the QoS policy.
        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
Resources:
  ExtensionResource:
    Type: ALIYUN::VPC::TrafficQos
    Properties:
      ResourceGroupId:
        Ref: ResourceGroupId
      Tags:
        Ref: Tags
      QosName:
        Ref: QosName
      QosDescription:
        Ref: QosDescription
Outputs:
  Tags:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags
    Description: The tags of the QoS policy.
  Progressing:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Progressing
    Description: The configuration progress of the QoS policy, ranging from **0** to **100**.
  QosDescription:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QosDescription
    Description: The description of the QoS policy.
  ResourceGroupId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceGroupId
    Description: The ID of the resource group.
  QosName:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QosName
    Description: The name of the QoS policy.
  QosId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QosId
    Description: The QoS policy ID.
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ResourceGroupId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the resource group."
      },
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
      "Default": null,
      "Required": false
    },
    "Tags": {
      "Description": {
        "en": "The tags of the TrafficQos resource."
      },
      "Required": false,
      "Default": null,
      "Type": "Json",
      "MaxLength": 20,
      "AssociationProperty": "List[Parameters]",
      "AssociationPropertyMetadata": {
        "Parameters": {
          "Key": {
            "Type": "String",
            "Required": true
          },
          "Value": {
            "Type": "String",
            "Default": null,
            "Required": false
          }
        },
        "ListMetadata": {
          "Order": [
            "Key",
            "Value"
          ]
        }
      }
    },
    "QosName": {
      "Type": "String",
      "Description": {
        "en": "The name of the QoS policy.\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
    },
    "QosDescription": {
      "Type": "String",
      "Description": {
        "en": "The description of the QoS policy.\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
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::TrafficQos",
      "Properties": {
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "Tags": {
          "Ref": "Tags"
        },
        "QosName": {
          "Ref": "QosName"
        },
        "QosDescription": {
          "Ref": "QosDescription"
        }
      }
    }
  },
  "Outputs": {
    "Tags": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      },
      "Description": "The tags of the QoS policy."
    },
    "Progressing": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Progressing"
        ]
      },
      "Description": "The configuration progress of the QoS policy, ranging from **0** to **100**."
    },
    "QosDescription": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QosDescription"
        ]
      },
      "Description": "The description of the QoS policy."
    },
    "ResourceGroupId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      },
      "Description": "The ID of the resource group."
    },
    "QosName": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QosName"
        ]
      },
      "Description": "The name of the QoS policy."
    },
    "QosId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QosId"
        ]
      },
      "Description": "The QoS policy ID."
    }
  }
}