ALIYUN::VPC::CommonBandwidthPackage is used to create an Internet shared bandwidth instance.

Statement

{
  "Type": "ALIYUN::VPC::CommonBandwidthPackage",
  "Properties": {
    "Description": String,
    "Zone": String,
    "ISP": String,
    "ResourceGroupId": String,
    "Bandwidth": Integer,
    "InternetChargeType": String,
    "Name": String
  }
}

Properties

Parameter Type Required Editable Description Constraint
Description String Not supported Supported The description of the Internet shared bandwidth instance. The description must be 2 to 256 characters in length. It must start with a letter, and cannot start with http:// or https:// the beginning.
Zone String Not granted Not granted The zone of the Internet shared bandwidth instance. You do not need to specify this parameter.
ISP String Not granted Not granted The line type of the EIP. Value: BGP (multi-line connection)
ResourceGroupId String Not granted Not granted The ID of the resource group to which the RDS instance belongs. None.
Bandwidth Integer Yes Yes The peak bandwidth of the Internet shared bandwidth instance. Value range: 2 to 5000.

Unit: Mbit/s.

InternetChargeType String Not granted Not granted The billing method of the Internet shared bandwidth instance. Valid values:
  • PayByBandwidth:
  • PayBy95: billed by enhanced 95th percentile

Default value: PayByBandwidth.

Name String Not supported Supported The name of the Internet shared bandwidth instance.
  • The name must be 2 to 128 characters in length.
  • It must start with a letter and can contain numbers, periods (.), underscores (_), and hyphen (-). It cannot start with http:// or https://.

Return value

Fn::GetAtt

BandwidthPackageId: The ID of the Internet shared bandwidth instance.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "CommonBandwidthPackage": {
      "Type": "ALIYUN::VPC::CommonBandwidthPackage",
      "Properties": {
        "Ratio": {
          "Ref": "Ratio"
        },
        "Description": {
          "Ref": "Description"
        },
        "Zone": {
          "Ref": "Zone"
        },
        "ISP": {
          "Ref": "ISP"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "Bandwidth": {
          "Ref": "Bandwidth"
        },
        "InternetChargeType": {
          "Ref": "InternetChargeType"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Parameters": {
    "Ratio": {
      "Default": 100,
      "Type": "Number",
      "Description": "The minimum consumption ratio of the Internet Shared Bandwidth instance. Default to 100.\nNote This parameter is only supported on the China site.",
      "MaxValue": 100,
      "MinValue": 0
    },
    "Description": {
      "MinLength": 2,
      "Type": "String",
      "Description": "The description of the Internet Shared Bandwidth instance.\nThe description must be 2 to 256 characters in length. It must start with a letter,\nand cannot start with http:// or https://.",
      "MaxLength": 256
    },
    "Zone": {
      "Type": "String",
      "Description": "Zone Id."
    },
    "ISP": {
      "Default": "BGP",
      "Type": "String",
      "Description": "Line type of EIP, value: BGP (multi-line)."
    },
    "ResourceGroupId":"",
      "Type": "String",
      "Description": "The ID of the resource group."
    },
    "Bandwidth": {
      "Type": "Number",
      "Description": "The peak bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.",
      "MinValue": 2
    },
    "InternetChargeType": {
      "Type": "String",
      "Description": "The billing model of the Internet Shared Bandwidth instance. Allowed values:\nPayByBandwidth (default): Billed by bandwidth.\nPayBy95: Charged at Enhanced 95."
    },
    "Name": {
      "MinLength": 2,
      "Type": "String",
      "Description": "The name of the Internet Shared Bandwidth instance.\nThe name must be 2 to 128 characters in length and can contain letters, numbers, periods\n(.), underscores (_), and hyphens (-). The name must start with a letter, and cannot\nstart with http:// or https://.",
      "MaxLength": 128
    }
  },
  "Outputs": {
    "BandwidthPackageId": {
      "Description": "The ID of the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "CommonBandwidthPackage",
          "BandwidthPackageId"
        ]
      }
    }
  }
}

YML example

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  CommonBandwidthPackage:
    Type: 'ALIYUN::VPC::CommonBandwidthPackage'
    Properties:
      Ratio:
        Ref: Ratio
      Description:
        Ref: Description
      Zone:
        Ref: Zone
      ISP:
        Ref: ISP
      ResourceGroupId:
        Ref: ResourceGroupId
      Bandwidth:
        Ref: Bandwidth
      InternetChargeType:
        Ref: InternetChargeType
      Name:
        Ref: Name
Parameters:
  Ratio:
    Default: 100
    Type: Number
    Description: >-
      The minimum consumption ratio of the Internet Shared Bandwidth instance.
      Default to 100.

      Note This parameter is only supported on the China site.
    MaxValue: 100
    MinValue: 0
  Description:
    MinLength: 2
    Type: String
    Description: >-
      The description of the Internet Shared Bandwidth instance.

      The description must be 2 to 256 characters in length. It must start with
      a letter,

      and cannot start with http:// or https://.
    MaxLength: 256
  Zone:
    Type: String
    Description: Zone Id.
  ISP:
    Default: BGP
    Type: String
    Description: 'Line type of EIP, value: BGP (multi-line).'
  ResourceGroupId:
    Type: String
    Description: The ID of the resource group.
  Bandwidth:
    Type: Number
    Description: >-
      The peak bandwidth of the Internet Shared Bandwidth instance. Unit:
      Mbit/s.
    MinValue: 2
  InternetChargeType:
    Type: String
    Description: >-
      The billing model of the Internet Shared Bandwidth instance. Allowed
      values:

      PayByBandwidth (default): Billed by bandwidth.

      PayBy95: Charged at Enhanced 95.
  Name:
    MinLength: 2
    Type: String
    Description: >-
      The name of the Internet Shared Bandwidth instance.

      The name must be 2 to 128 characters in length and can contain letters,
      numbers, periods

      (.), underscores (_), and hyphens (-). The name must start with a letter,
      and cannot

      start with http:// or https://.
    MaxLength: 128
Outputs:
  BandwidthPackageId:
    Description: The ID of the Internet Shared Bandwidth instance.
    Value:
      'Fn::GetAtt':
        -CommonBandwidthPackage
        -BandwidthPackageId