ALIYUN::CEN::CenBandwidthPackage is used to purchase a bandwidth plan before you use Cloud Enterprise Network (CEN) to connect network instances in different regions.

Syntax

{
  "Type": "ALIYUN::CEN::CenBandwidthPackage",
  "Properties": {
    "Description": String,
    "BandwidthPackageChargeType": String,
    "GeographicRegionBId": String,
    "GeographicRegionAId": String,
    "PricingCycle": String,
    "AutoRenew": "Boolean",
    "Bandwidth": Integer,
    "Period": Integer,
    "AutoPay": "Boolean",
    "AutoRenewDuration": Integer,
    "Name": String,
    "ResourceGroupId": String
  }
} 

Properties

PropertyTypeRequiredEditableDescriptionConstraint
GeographicRegionAIdStringYesNoThe area for which you want to enable cross-region communication.Valid values:
  • China
  • North-America
  • Asia-Pacific
  • Europe
  • Australia
ResourceGroupIdStringNoYesThe ID of the resource group. None
DescriptionStringNoYesThe description of the 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://.

The description can contain letters, digits, hyphens (-), periods (.), and underscores (_).

AutoPayBooleanNoNoSpecifies whether to enable automatic payment.

Valid values:

  • true. This is the default value.
  • false.
PeriodIntegerNoNoThe subscription period of the bandwidth plan.Default value: 1.
GeographicRegionBIdStringYesNoThe other area for which you want to enable cross-region communication.Valid values:
  • China
  • North-America
  • Asia-Pacific
  • Europe
  • Australiat
BandwidthIntegerYesYesThe peak bandwidth provided by the bandwidth plan.Unit: Mbit/s.

The minimum value is 2.

PricingCycleStringNoNoThe billing cycle of the bandwidth plan.Valid values:
  • Month. This is the default value.
  • Year.
BandwidthPackageChargeTypeStringNoNoThe billing method of the bandwidth plan.Valid values:
  • POSTPAY
  • PREPAY
NameStringNoYesThe name of the bandwidth plan.

The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://.

The name can contain letters, digits, periods (.), underscores (_), and hyphens (-).

AutoRenewBooleanNoNoSpecifies whether to enable auto-renewal.Valid values:
  • true.
  • false. This is the default value.
AutoRenewDurationIntegerNoNoThe auto-renewal period.

This property takes effect only if the AutoRenew property is set to true.

Valid values:
  • 1
  • 2
  • 3
Unit: months.

Response parameters

Fn::GetAtt

CenBandwidthPackageId: the ID of the purchased bandwidth plan.

Examples

  • YAMLformat

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      CenBandwidthPackage:
        Type: ALIYUN::CEN::CenBandwidthPackage
        Properties:
          GeographicRegionBId: China
          GeographicRegionAId: China
          Bandwidth: 3
          BandwidthPackageChargeType: POSTPAY
    Outputs:
      CenBandwidthPackageId:
        Description: The ID of the bandwidth package.
        Value:
          Fn::GetAtt:
            - CenBandwidthPackage
            - CenBandwidthPackageId
  • JSONformat

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "CenBandwidthPackage": {
          "Type": "ALIYUN::CEN::CenBandwidthPackage",
          "Properties": {
            "GeographicRegionBId": "China",
            "GeographicRegionAId": "China",
            "Bandwidth": 3,
            "BandwidthPackageChargeType": "POSTPAY"
          }
        }
      },
      "Outputs": {
        "CenBandwidthPackageId": {
          "Description": "The ID of the bandwidth package.",
          "Value": {
            "Fn::GetAtt": [
              "CenBandwidthPackage",
              "CenBandwidthPackageId"
            ]
          }
        }
      }
    }