DATASOURCE::VPC::PublicIpAddressPool is used to query the basic information about an available IP address pool.
Syntax
{
"Type": "DATASOURCE::VPC::PublicIpAddressPool",
"Properties": {
"PublicIpAddressPoolId": String,
"RefreshOptions": String
}
}Properties
Property | Type | Required | Editable | Description | Constraint |
Property | Type | Required | Editable | Description | Constraint |
PublicIpAddressPoolId | String | Yes | Yes | The ID of the IP address pool. | None. |
RefreshOptions | String | No | Yes | The refresh policy for data source resources when the stack is updated. | Valid values:
|
Return values
Fn::GetAtt
UsedIpNum: the total number of available IP addresses in the IP address pool.
Description: the description of the IP address pool.
ResourceGroupId: the ID of the resource group.
TotalIpNum: the number of used IP addresses in the IP address pool.
PublicIpAddressPoolName: the name of the IP address pool.
Isp: the line type.
CreateTime: the time when the IP address pool was created.
IpAddressRemaining: indicates whether idle IP addresses exist.
PublicIpAddressPoolId: the ID of the IP address pool to which the elastic IP address (EIP) belongs.
Tags: the tags of the EIP.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
PublicIpAddressPoolId:
Type: String
Description:
en: The first ID of the resource.
Required: true
Resources:
ExtensionDataSource:
Type: DATASOURCE::VPC::PublicIpAddressPool
Properties:
PublicIpAddressPoolId:
Ref: PublicIpAddressPoolId
Outputs:
UsedIpNum:
Description: Used ip number of PublicIpAddressPool.
Value:
Fn::GetAtt:
- ExtensionDataSource
- UsedIpNum
Description:
Description: Description.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Description
ResourceGroupId:
Description: The ID of the resource group to which the VPC belongs.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ResourceGroupId
TotalIpNum:
Description: Total ip number of PublicIpAddressPool.
Value:
Fn::GetAtt:
- ExtensionDataSource
- TotalIpNum
PublicIpAddressPoolName:
Description: The name of the resource.
Value:
Fn::GetAtt:
- ExtensionDataSource
- PublicIpAddressPoolName
Isp:
Description: Service providers.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Isp
CreateTime:
Description: The creation time of the resource.
Value:
Fn::GetAtt:
- ExtensionDataSource
- CreateTime
IpAddressRemaining:
Description: Whether there is a free IP address.
Value:
Fn::GetAtt:
- ExtensionDataSource
- IpAddressRemaining
PublicIpAddressPoolId:
Description: The first ID of the resource.
Value:
Fn::GetAtt:
- ExtensionDataSource
- PublicIpAddressPoolId
Tags:
Description: The tags of PrefixList.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Tags
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"PublicIpAddressPoolId": {
"Type": "String",
"Description": {
"en": "The first ID of the resource."
},
"Required": true
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::VPC::PublicIpAddressPool",
"Properties": {
"PublicIpAddressPoolId": {
"Ref": "PublicIpAddressPoolId"
}
}
}
},
"Outputs": {
"UsedIpNum": {
"Description": "Used ip number of PublicIpAddressPool.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"UsedIpNum"
]
}
},
"Description": {
"Description": "Description.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Description"
]
}
},
"ResourceGroupId": {
"Description": "The ID of the resource group to which the VPC belongs.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ResourceGroupId"
]
}
},
"TotalIpNum": {
"Description": "Total ip number of PublicIpAddressPool.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"TotalIpNum"
]
}
},
"PublicIpAddressPoolName": {
"Description": "The name of the resource.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"PublicIpAddressPoolName"
]
}
},
"Isp": {
"Description": "Service providers.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Isp"
]
}
},
"CreateTime": {
"Description": "The creation time of the resource.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"CreateTime"
]
}
},
"IpAddressRemaining": {
"Description": "Whether there is a free IP address.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"IpAddressRemaining"
]
}
},
"PublicIpAddressPoolId": {
"Description": "The first ID of the resource.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"PublicIpAddressPoolId"
]
}
},
"Tags": {
"Description": "The tags of PrefixList.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Tags"
]
}
}
}
}
