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
  }
} 

Properties

Property Type Required Editable Description Constraint
GeographicRegionAId String Yes No The ID of the geographic region where one network instance resides. Valid values:
  • China
  • North-America
  • Asia-Pacific
  • Europe
  • Australia
Description String No Yes The description of the bandwidth plan. The description must be 2 to 256 characters in length. It must start with a letter and cannot start with http:// or https://.

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

AutoPay Boolean No No Specifies whether to enable automatic payment. Default value: false.

Valid values:

  • true
  • false
Period Integer No No The subscription period of the bandwidth plan. Default value: 1.
GeographicRegionBId String Yes No The ID of geographic region where another network instance resides. Valid values:
  • China
  • North-America
  • Asia-Pacific
  • Europe
  • Australiat
Bandwidth Integer Yes Yes The peak bandwidth provided by the bandwidth plan. Unit: Mbit/s.

Minimum value: 2.

PricingCycle String No No The billing cycle of the bandwidth plan. Default value: Month. Valid values:
  • Month
  • Year
BandwidthPackageChargeType String No No The billing method of the bandwidth plan. Valid values:
  • POSTPAY
  • PREPAY
Name String No Yes The name of the bandwidth plan.

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

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

AutoRenew Boolean No No Specifies whether to enable auto-renewal. Default value: false. Valid values:
  • true
  • false
AutoRenewDuration Integer No No The auto-renewal period.

This parameter takes effect when the AutoRenew parameter is set to true.

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

Response parameters

Fn::GetAtt

CenBandwidthPackageId: the ID of the purchased bandwidth plan.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Description": {
      "Type": "String",
      "Description": "The description of the bandwidth package.\nThe description can contain [2,256] characters, numbers, underscores, and hyphens, and the name must start with English letters, but cannot start with http:// or https://."
    },
    "BandwidthPackageChargeType": {
      "Type": "String",
      "Description": "The billing method. Valid value: PREPAY, POSTPAY (Default)",
      "AllowedValues": [
        "PREPAY",
        "POSTPAY"
      ]
    },
    "GeographicRegionBId": {
      "Type": "String",
      "Description": "The other area B to connect.\nValid value: China | North-America | Asia-Pacific | Europe | Australia",
      "AllowedValues": [
        "China",
        "North-America",
        "Asia-Pacific",
        "Europe",
        "Australia"
      ]
    },
    "GeographicRegionAId": {
      "Type": "String",
      "Description": "The other area A to connect.\nValid value: China | North-America | Asia-Pacific | Europe | Australia",
      "AllowedValues": [
        "China",
        "North-America",
        "Asia-Pacific",
        "Europe",
        "Australia"
      ]
    },
    "PricingCycle": {
      "Type": "String",
      "Description": "The pricing cycle.",
      "AllowedValues": [
        "Month",
        "Year"
      ],
      "Default": "Month"
    },
    "AutoRenew": {
      "Type": "Boolean",
      "Description": "Indicates whether automatic renewal is enabled. Valid values:true: Automatic renewal is enabled.false: Automatic renewal is not enabled. You must renew the instance manually.Default value: false.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Bandwidth": {
      "Type": "Number",
      "Description": "The bandwidth in Mbps of the bandwidth package. The bandwidth cannot be less than 2 Mbps.",
      "MinValue": 2
    },
    "Period": {
      "Type": "Number",
      "Description": "The purchase period. The default value is 1.",
      "Default": 1
    },
    "AutoPay": {
      "Type": "Boolean",
      "Description": "Whether to automatically pay the bill. Valid value:\ntrue\nfalse (Default)",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ],
      "Default": false
    },
    "AutoRenewDuration": {
      "Type": "Number",
      "Description": "Duration of each automatic renewals. It takes effect when AutoRenew is true.",
      "AllowedValues": [
        1,
        2,
        3,
        6
      ]
    },
    "Name": {
      "Type": "String",
      "Description": "The name of the bandwidth package.\nThe name can contain 2-128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. It must start with English letters, but cannot start with http:// or https://."
    }
  },
  "Resources": {
    "CenBandwidthPackage": {
      "Type": "ALIYUN::CEN::CenBandwidthPackage",
      "Properties": {
        "Description": {
          "Ref": "Description"
        },
        "BandwidthPackageChargeType": {
          "Ref": "BandwidthPackageChargeType"
        },
        "GeographicRegionBId": {
          "Ref": "GeographicRegionBId"
        },
        "GeographicRegionAId": {
          "Ref": "GeographicRegionAId"
        },
        "PricingCycle": {
          "Ref": "PricingCycle"
        },
        "AutoRenew": {
          "Ref": "AutoRenew"
        },
        "Bandwidth": {
          "Ref": "Bandwidth"
        },
        "Period": {
          "Ref": "Period"
        },
        "AutoPay": {
          "Ref": "AutoPay"
        },
        "AutoRenewDuration": {
          "Ref": "AutoRenewDuration"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "CenBandwidthPackageId": {
      "Description": "The ID of the bandwidth package.",
      "Value": {
        "Fn::GetAtt": [
          "CenBandwidthPackage",
          "CenBandwidthPackageId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Description:
    Type: String
    Description: >-
      The description of the bandwidth package.

      The description can contain [2,256] characters, numbers, underscores, and
      hyphens, and the name must start with English letters, but cannot start
      with http:// or https://.
  BandwidthPackageChargeType:
    Type: String
    Description: 'The billing method. Valid value: PREPAY, POSTPAY (Default)'
    AllowedValues:
      - PREPAY
      - POSTPAY
  GeographicRegionBId:
    Type: String
    Description: |-
      The other area B to connect.
      Valid value: China | North-America | Asia-Pacific | Europe | Australia
    AllowedValues:
      - China
      - North-America
      - Asia-Pacific
      - Europe
      - Australia
  GeographicRegionAId:
    Type: String
    Description: |-
      The other area A to connect.
      Valid value: China | North-America | Asia-Pacific | Europe | Australia
    AllowedValues:
      - China
      - North-America
      - Asia-Pacific
      - Europe
      - Australia
  PricingCycle:
    Type: String
    Description: The pricing cycle.
    AllowedValues:
      - Month
      - Year
    Default: Month
  AutoRenew:
    Type: Boolean
    Description: >-
      Indicates whether automatic renewal is enabled. Valid values:true:
      Automatic renewal is enabled.false: Automatic renewal is not enabled. You
      must renew the instance manually.Default value: false.
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
  Bandwidth:
    Type: Number
    Description: >-
      The bandwidth in Mbps of the bandwidth package. The bandwidth cannot be
      less than 2 Mbps.
    MinValue: 2
  Period:
    Type: Number
    Description: The purchase period. The default value is 1.
    Default: 1
  AutoPay:
    Type: Boolean
    Description: |-
      Whether to automatically pay the bill. Valid value:
      true
      false (Default)
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
    Default: false
  AutoRenewDuration:
    Type: Number
    Description: >-
      Duration of each automatic renewals. It takes effect when AutoRenew is
      true.
    AllowedValues:
      - 1
      - 2
      - 3
      - 6
  Name:
    Type: String
    Description: >-
      The name of the bandwidth package.

      The name can contain 2-128 characters including a-z, A-Z, 0-9, periods,
      underlines, and hyphens. It must start with English letters, but cannot
      start with http:// or https://.
Resources:
  CenBandwidthPackage:
    Type: 'ALIYUN::CEN::CenBandwidthPackage'
    Properties:
      Description:
        Ref: Description
      BandwidthPackageChargeType:
        Ref: BandwidthPackageChargeType
      GeographicRegionBId:
        Ref: GeographicRegionBId
      GeographicRegionAId:
        Ref: GeographicRegionAId
      PricingCycle:
        Ref: PricingCycle
      AutoRenew:
        Ref: AutoRenew
      Bandwidth:
        Ref: Bandwidth
      Period:
        Ref: Period
      AutoPay:
        Ref: AutoPay
      AutoRenewDuration:
        Ref: AutoRenewDuration
      Name:
        Ref: Name
Outputs:
  CenBandwidthPackageId:
    Description: The ID of the bandwidth package.
    Value:
      'Fn::GetAtt':
        - CenBandwidthPackage
        - CenBandwidthPackageId