ALIYUN::VPC::CommonBandwidthPackage - Resource Orchestration Service

ALIYUN::VPC::CommonBandwidthPackage is used to create an elastic IP address (EIP) bandwidth plan.

Syntax

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

Properties


Property	Type	Required	Editable	Description	Constraint
Description	String	No	Yes	The description of the EIP bandwidth plan.	The description must be 2 to 256 characters in length. It must start with a letter but cannot start with `http://` or `https://`.
Zone	String	No	No	The zone ID of the EIP bandwidth plan.	None.
ISP	String	No	No	The line type of the EIP.	Set the value to BGP, which specifies BGP (Multi-ISP).
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.
Bandwidth	Integer	Yes	Yes	The maximum bandwidth of the EIP bandwidth plan.	Valid values: 2 to 5000. Unit: Mbit/s.
InternetChargeType	String	No	No	The metering method of the EIP bandwidth plan.	Default value: PayByBandwidth. Valid values: PayByBandwidth: the pay-by-bandwidth metering method PayBy95: the enhanced 95th percentile metering method
Name	String	No	Yes	The name of the EIP bandwidth plan.	The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter but cannot start with `http://` or `https://`.
Tags	List	No	Yes	The tags of the EIP bandwidth plan.	You can add up to 20 tags. For more information, see Tags properties.

Tags syntax

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

Tags properties


Field	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The key of the tag.	The key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.
Value	String	No	No	The value of the tag.	The value must be 0 to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

BandwidthPackageId: the ID of the EIP bandwidth plan.

Examples

YAMLformat

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  CommonBandwidthPackage:
    Type: ALIYUN::VPC::CommonBandwidthPackage
    Properties:
      Description: Test
      Name: test-dsa
      Bandwidth: 5
      InternetChargeType: PayByBandwidth
Outputs:
  BandwidthPackageId:
    Description: The ID of the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - CommonBandwidthPackage
        - BandwidthPackageId

JSONformat

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "CommonBandwidthPackage": {
      "Type": "ALIYUN::VPC::CommonBandwidthPackage",
      "Properties": {
        "Description": "Test",
        "Name": "test-dsa",
        "Bandwidth": 5,
        "InternetChargeType": "PayByBandwidth"
      }
    }
  },
  "Outputs": {
    "BandwidthPackageId": {
      "Description": "The ID of the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "CommonBandwidthPackage",
          "BandwidthPackageId"
        ]
      }
    }
  }
}{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "CommonBandwidthPackage": {
      "Type": "ALIYUN::VPC::CommonBandwidthPackage",
      "Properties": {
        "Description": "Test",
        "Name": "test-dsa",
        "Bandwidth": 5,
        "InternetChargeType": "PayByBandwidth"
      }
    }
  },
  "Outputs": {
    "BandwidthPackageId": {
      "Description": "The ID of the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "CommonBandwidthPackage",
          "BandwidthPackageId"
        ]
      }
    }
  }
}

To view more examples, visit SnatEntry.json and SnatEntry.yml. In the examples, the ALIYUN::ECS::VPC, ALIYUN::ECS::VSwitch, ALIYUN::VPC::SnatEntry, ALIYUN::VPC::CommonBandwidthPackage, ALIYUN::VPC::CommonBandwidthPackageIp, ALIYUN::VPC::Ipv6Gateway, and ALIYUN::VPC::Ipv6InternetBandwidth resource types are involved.