DATASOURCE::VPC::PublicIpAddressPools - Resource Orchestration Service

DATASOURCE::VPC::PublicIpAddressPools is used to query available IP address pools.

Syntax

{
  "Type": "DATASOURCE::VPC::PublicIpAddressPools",
  "Properties": {
    "ResourceGroupId": String,
    "PublicIpAddressPoolName": String,
    "Isp": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ResourceGroupId	String	No	Yes	The ID of the resource group to which the IP address pool belongs.	None
PublicIpAddressPoolName	String	No	Yes	The name of the IP address pool.	This property is optional. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.
Isp	String	No	Yes	The line type.	Valid values: BGP: BGP (Multi-ISP) BGP_PRO: BGP (Multi-ISP) Pro line For information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see What is EIP?. If you are allowed to use single-ISP bandwidth, one of the following values is returned: ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 If your services are deployed in China East 1 Finance, BGP_FinanceCloud is returned.

Return values

Fn::GetAtt

PublicIpAddressPoolIds: the IDs of the IP address pools.
PublicIpAddressPools: the IP address pools.

Property	Type	Description	Constraint
PublicIpAddressPoolIds	List	The IDs of the IP address pools.	None
PublicIpAddressPoolIds	List	The IP address pools.	None
Status	String	The status of the IP address pool.	None
Isp	String	The line type.	None
Description	String	The description of the IP address pool.	None
IpAddressRemaining	Boolean	Indicates whether the IP address pool has idle IP addresses.	Valid values: true false
Tags	List	The tags.	None
TotalIpNum	Integer	The total number of IP addresses in the public IP address pool.	None
PublicIpAddressPoolId	String	The ID of the IP address pool.	None
ResourceGroupId	String	The ID of the resource group to which the IP address pool belongs.	None
CreateTime	String	The time when the IP address pool was created.	None
UsedIpNum	String	The number of occupied IP addresses in the public IP address pool.	None
PublicIpAddressPoolName	String	The name of the IP address pool.	None
RegionId	String	The ID of the region where the IP address pool that you want to query resides.	None

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Isp:
    AllowedValues:
    - BGP
    - BGP_PRO
    - ChinaTelecom
    - ChinaUnicom
    - ChinaMobile
    - ChinaTelecom_L2
    - ChinaUnicom_L2
    - ChinaMobile_L2
    Description: "The line type. Valid values:\nBGP (default): BGP (Multi-ISP) lines\n\
      BGP_PRO: BGP (Multi-ISP) Pro lines\nFor more information about BGP (Multi-ISP)\
      \ and BGP (Multi-ISP) Pro, see EIP line types.\nIf you are allowed to use single-ISP\
      \ bandwidth, you can also choose one of the following values:\nChinaTelecom:\
      \ China Telecom\nChinaUnicom: China Unicom\nChinaMobile: China Mobile\nChinaTelecom_L2:\
      \ China Telecom L2\nChinaUnicom_L2: China Unicom L2\nChinaMobile_L2: China Mobile\
      \ L2\nIf your services are deployed in China East 1 Finance, \nthis parameter\
      \ is required and you must set the value to BGP_FinanceCloud."
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      Isp:
        Ref: Isp
    Type: DATASOURCE::VPC::PublicIpAddressPools
Outputs:
  PublicIpAddressPoolIds:
    Description: The list of public ip address pool IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicIpAddressPoolIds
  PublicIpAddressPools:
    Description: The list of public ip address pools.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicIpAddressPools

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Isp": {
      "Type": "String",
      "Description": "The line type. Valid values:\nBGP (default): BGP (Multi-ISP) lines\nBGP_PRO: BGP (Multi-ISP) Pro lines\nFor more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see EIP line types.\nIf you are allowed to use single-ISP bandwidth, you can also choose one of the following values:\nChinaTelecom: China Telecom\nChinaUnicom: China Unicom\nChinaMobile: China Mobile\nChinaTelecom_L2: China Telecom L2\nChinaUnicom_L2: China Unicom L2\nChinaMobile_L2: China Mobile L2\nIf your services are deployed in China East 1 Finance, \nthis parameter is required and you must set the value to BGP_FinanceCloud.",
      "AllowedValues": [
        "BGP",
        "BGP_PRO",
        "ChinaTelecom",
        "ChinaUnicom",
        "ChinaMobile",
        "ChinaTelecom_L2",
        "ChinaUnicom_L2",
        "ChinaMobile_L2"
      ]
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::PublicIpAddressPools",
      "Properties": {
        "Isp": {
          "Ref": "Isp"
        }
      }
    }
  },
  "Outputs": {
    "PublicIpAddressPoolIds": {
      "Description": "The list of public ip address pool IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddressPoolIds"
        ]
      }
    },
    "PublicIpAddressPools": {
      "Description": "The list of public ip address pools.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddressPools"
        ]
      }
    }
  }
}