Creates an Internet Shared Bandwidth instance.
This resource supports only pay-as-you-go Internet Shared Bandwidth instances.
Syntax
{
"Type": "ALIYUN::VPC::CommonBandwidthPackage",
"Properties": {
"Ratio": Integer,
"Description": String,
"Zone": String,
"ISP": String,
"ResourceGroupId": String,
"Bandwidth": Integer,
"InternetChargeType": String,
"Name": String,
"DeletionProtection": Boolean
"Tags": List
}
}
Properties
|
Property |
Type |
Required |
Update allowed |
Description |
Constraints |
|
Ratio |
Integer |
No |
No |
The minimum bandwidth percentage. |
Required when InternetChargeType is set to PayBy95. Valid value: 20. This specifies a minimum bandwidth percentage of 20%. |
|
Description |
String |
No |
Yes |
The description of the instance. |
The description must be 2 to 256 characters in length. It must start with a letter or a Chinese character, but cannot start with |
|
Zone |
String |
No |
No |
The zone of the instance. |
You do not need to specify this parameter. |
|
ISP |
String |
No |
No |
The line type of the elastic IP address (EIP). |
Valid value: BGP (Multi-ISP). |
|
ResourceGroupId |
String |
No |
Yes |
The ID of the resource group. |
None |
|
Bandwidth |
Integer |
Yes |
Yes |
The peak bandwidth of the instance. |
Valid values: 2 to 5000. Unit: Mbps. |
|
InternetChargeType |
String |
No |
No |
The billing method of the instance. |
Valid values:
|
|
Name |
String |
No |
Yes |
The name of the instance. |
The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character, but cannot start with |
|
Tags |
List |
No |
Yes |
The tags of the instance. |
You can add up to 20 tags. For more information, see Tags properties. |
|
DeletionProtection |
Boolean |
No |
Yes |
Specifies whether to enable deletion protection for the instance. |
Valid values:
|
Tags syntax
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags properties
|
Property Name |
Type |
Required |
Update allowed |
Description |
Constraints |
|
Key |
String |
Yes |
No |
The tag key. |
The tag key must be 1 to 128 characters in length. It cannot start with |
|
Value |
String |
No |
No |
The tag value. |
The tag value must be 0 to 128 characters in length. It cannot start with |
Return values
Fn::GetAtt
-
BandwidthPackageId: The ID of the Internet Shared Bandwidth instance.
-
Arn: The Alibaba Cloud Resource Name (ARN) of the resource.
Examples
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"
]
}
}
}
}{
"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"
]
}
}
}
}