ALIYUN::VPC::CommonBandwidthPackage_VPC_资源类型_资源编排

ALIYUN::VPC::CommonBandwidthPackage类型用于创建共享带宽实例。

语法

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

属性


属性名称	类型	必须	允许更新	描述	约束
Ratio	Integer	否	否	共享带宽的保底百分比，取值为20，即保底百分比的范围是20%。	当InternetChargeType取值为PayBy95时，需指定此参数。默认值：100。
Description	String	否	是	共享带宽的描述信息。	长度为2~256个字符，必须以字母或中文开头，但不能以`http://`或`https://`开头。
Zone	String	否	否	共享带宽的可用区。	不需要传入该参数。
ISP	String	否	否	EIP的线路类型。	取值：BGP（多线）。
ResourceGroupId	String	否	否	资源组ID。	无。
Bandwidth	Integer	是	是	共享带宽的带宽峰值。	取值范围：2~5000。单位：Mbps。
InternetChargeType	String	否	否	共享带宽的计费方式。	取值范围： PayByBandwidth：按带宽计费。 PayBy95：按增强型95计费。默认值：PayByBandwidth。
Name	String	否	是	共享带宽的名称。	长度为2~128个字符。必须以字母或中文开头，可包含数字、点号（.）、下划线（_）和短横线（-），但不能以http://或https://开头。

返回值

Fn::GetAtt

BandwidthPackageId: 共享带宽实例的ID。

示例

JSON示例

{
  "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示例

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