ALIYUN::ECD::NetworkPackage - Resource Orchestration Service

ALIYUN::ECD::NetworkPackage is used to create a premium bandwidth plan for an office network.

Syntax

{
  "Type": "ALIYUN::ECD::NetworkPackage",
  "Properties": {
    "OfficeSiteId": String,
    "PromotionId": String,
    "Bandwidth": Integer,
    "AutoRenew": Boolean,
    "Period": Integer,
    "AutoPay": Boolean,
    "PayType": String,
    "PeriodUnit": String,
    "InternetChargeType": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
Bandwidth	Integer	Yes	No	The bandwidth provided by the premium bandwidth plan.	Unit: Mbit/s. Valid values when PayType is set to PrePaid: 2 to 1000. Valid values when PayType is set to PostPaid and InternetChargeType is set to PayByTraffic: 2 to 200. Valid values when PayType is set to PostPaid and InternetChargeType is set to PayByBandwidth: 2 to 1000.
OfficeSiteId	String	Yes	No	The ID of the office network.	None.
AutoPay	Boolean	No	No	Specifies whether to enable automatic payment.	Valid values: true (default): enables automatic payment. You must make sure that your account has sufficient balance. If your account has insufficient balance, abnormal orders are generated. false: disables automatic payment. In this case, an order is generated, but no payment is made. To make the payment, you can log on to the Elastic Desktop Service (EDS) console, go to the Orders page in the Expenses and Costs console, and then find the order based on the order ID in the return value.
AutoRenew	Boolean	No	No	Specifies whether to enable auto-renewal.	Valid values: true false
InternetChargeType	String	No	No	The metering method of the premium bandwidth plan.	Valid value when `PayType` is set to `PrePaid`: PayByBandwidth Valid values when `PayType` is set to `PostPaid`: PayByTraffic PayByBandwidth
PayType	String	No	No	The billing method.	Valid values: PostPaid PrePaid
Period	Integer	No	No	The subscription duration of the premium bandwidth plan.	The unit of the property value is specified by PeriodUnit. You must specify Period only when PayType is set to PrePaid. Valid values when PeriodUnit is set to Month: 1 2 3 6 Valid values when PeriodUnit is set to Year: 1 2 3 4 5
PeriodUnit	String	No	No	The unit of the subscription duration of the premium bandwidth plan.	You must specify this property only when `PayType` is set to `PrePaid`. Valid values: Month Year Week
PromotionId	String	No	No	The ID of the sales promotion.	None.

Return values

Fn::GetAtt

NetworkPackageId: the ID of the premium bandwidth plan.

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  OfficeSiteId:
    Type: String
    Description:
      en: The ID of the workspace..
    Required: true
  Bandwidth:
    Type: Number
    Description:
      en: |-
        The maximum public bandwidth. Unit: Mbit/s.
        Valid values for the pay-by-data-transfer type (PayByTraffic): 10 to 200. 
         Valid values for the pay-by-bandwith type (PayByBandwidth): 10 to 1000.
    Required: true
    MinValue: 2
    MaxValue: 1000
  PayType:
    Type: String
    Description:
      en: |-
        The billing method of the Internet access package. Enumeration Value:
        PostPaid
        PrePaid
    AllowedValues:
      - PostPaid
      - PrePaid
    Required: false
  InternetChargeType:
    AssociationPropertyMetadata:
      LocaleKey: InternetChargeType
    Type: String
    Description:
      en: |-
        The metering method of the pay-as-you-go Internet access package. Valid values: 
        PayByTraffic: pay-by-data-transfer.
        PayByBandwidth: pay-by-bandwidth. 
        Default value: PayByTraffic.
    AllowedValues:
      - PayByTraffic
      - PayByBandwidth
    Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::ECD::NetworkPackage
    Properties:
      OfficeSiteId:
        Ref: OfficeSiteId
      Bandwidth:
        Ref: Bandwidth
      PayType:
        Ref: PayType
      InternetChargeType:
        Ref: InternetChargeType
Outputs:
  NetworkPackageId:
    Description: The ID of the Internet access package.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NetworkPackageId

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "OfficeSiteId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the workspace.."
      },
      "Required": true
    },
    "Bandwidth": {
      "Type": "Number",
      "Description": {
        "en": "The maximum public bandwidth. Unit: Mbit/s.\nValid values for the pay-by-data-transfer type (PayByTraffic): 10 to 200. \n Valid values for the pay-by-bandwith type (PayByBandwidth): 10 to 1000."
      },
      "Required": true,
      "MinValue": 2,
      "MaxValue": 1000
    },
    "PayType": {
      "Type": "String",
      "Description": {
        "en": "The billing method of the Internet access package. Enumeration Value:\nPostPaid\nPrePaid"
      },
      "AllowedValues": [
        "PostPaid",
        "PrePaid"
      ],
      "Required": false
    },
    "InternetChargeType": {
      "AssociationPropertyMetadata": {
        "LocaleKey": "InternetChargeType"
      },
      "Type": "String",
      "Description": {
        "en": "The metering method of the pay-as-you-go Internet access package. Valid values: \nPayByTraffic: pay-by-data-transfer.\nPayByBandwidth: pay-by-bandwidth. \nDefault value: PayByTraffic."
      },
      "AllowedValues": [
        "PayByTraffic",
        "PayByBandwidth"
      ],
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ECD::NetworkPackage",
      "Properties": {
        "OfficeSiteId": {
          "Ref": "OfficeSiteId"
        },
        "Bandwidth": {
          "Ref": "Bandwidth"
        },
        "PayType": {
          "Ref": "PayType"
        },
        "InternetChargeType": {
          "Ref": "InternetChargeType"
        }
      }
    }
  },
  "Outputs": {
    "NetworkPackageId": {
      "Description": "The ID of the Internet access package.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NetworkPackageId"
        ]
      }
    }
  }
}

Syntax

Properties

Return values

Examples

YAML format

JSON format

`YAML` format

`JSON` format