Automate EIP Binding to Shared Bandwidth via ROS Template - ROS

The ALIYUN::VPC::CommonBandwidthPackageIp resource adds one or more EIPs to a shared bandwidth instance.

Note

Note the following when you use this resource to add EIPs:

You can add only pay-as-you-go EIPs.
The EIPs and the shared bandwidth instance must be in the same region.

Syntax

{
  "Type": "ALIYUN::VPC::CommonBandwidthPackageIp",
  "Properties": {
    "Eips": List,
    "BandwidthPackageId": String
  }
}

Properties

Parameter	Type	Required	Update allowed	Description	Constraints
Eips	List	Yes	No	The EIPs to add to the shared bandwidth instance.	None.
BandwidthPackageId	String	Yes	No	The ID of the shared bandwidth instance.	None.

Eips syntax

"Eips": [
  {
    "Bandwidth": Integer,
    "AllocationId": String,
    "IpType": String
  }
]

Eips properties

Parameter	Type	Required	Update allowed	Description	Constraints
Bandwidth	Integer	No	No	The peak bandwidth for the EIP.	A value of 0 indicates that the bandwidth is unlimited. Default value: 0.
AllocationId	String	Yes	No	The ID of the EIP instance.	None.
IpType	String	No	No	The network type.	Valid values: EIP: Adds the EIP to the shared bandwidth instance.

Return values

Fn::GetAtt

AllocationIds: The IDs of the EIPs.
IpAddresses: The IP addresses of the EIPs.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BandwidthPackageId:
    Type: String
    Description: The ID of the shared bandwidth instance.
Resources:
  CommonBandwidthPackageIp:
    Type: ALIYUN::VPC::CommonBandwidthPackageIp
    Properties:
      Eips:
        - Bandwidth: 5
          AllocationId: eip-8vbwv47kgXXXXXXXXX
      BandwidthPackageId:
        Ref: BandwidthPackageId
Outputs:
  AllocationIds:
    Description: The allocation IDs of the EIPs in the shared bandwidth package.
    Value:
      Fn::GetAtt:
        - CommonBandwidthPackageIp
        - AllocationIds
  IpAddresses:
    Description: The IP addresses of the EIPs in the shared bandwidth package.
    Value:
      Fn::GetAtt:
        - CommonBandwidthPackageIp
        - IpAddresses

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BandwidthPackageId": {
      "Type": "String",
      "Description": "The ID of the shared bandwidth instance."
    }
  },
  "Resources": {
    "CommonBandwidthPackageIp": {
      "Type": "ALIYUN::VPC::CommonBandwidthPackageIp",
      "Properties": {
        "Eips": [
          {
            "Bandwidth": 5,
            "AllocationId": "eip-8vbwv47kgXXXXXXXXX"
          }
        ],
        "BandwidthPackageId": {
          "Ref": "BandwidthPackageId"
        }
      }
    }
  },
  "Outputs": {
    "AllocationIds": {
      "Description": "The allocation IDs of the EIPs in the shared bandwidth package.",
      "Value": {
        "Fn::GetAtt": [
          "CommonBandwidthPackageIp",
          "AllocationIds"
        ]
      }
    },
    "IpAddresses": {
      "Description": "The IP addresses of the EIPs in the shared bandwidth package.",
      "Value": {
        "Fn::GetAtt": [
          "CommonBandwidthPackageIp",
          "IpAddresses"
        ]
      }
    }
  }
}