Docs
Packagesalicloud.vpc.PublicIpAddressPool
Explore with Pulumi AI
Provides a Vpc Public Ip Address Pool resource.
For information about Vpc Public Ip Address Pool and how to use it, see What is Public Ip Address Pool.
NOTE: Available since v1.186.0.
Example Usage
Basic Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "tf-example";
var defaultResourceGroups = AliCloud.ResourceManager.GetResourceGroups.Invoke(new()
{
Status = "OK",
});
var defaultPublicIpAddressPool = new AliCloud.Vpc.PublicIpAddressPool("defaultPublicIpAddressPool", new()
{
Description = name,
PublicIpAddressPoolName = name,
Isp = "BGP",
ResourceGroupId = defaultResourceGroups.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[0]),
});
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "tf-example"
if param := cfg.Get("name"); param != "" {
name = param
}
defaultResourceGroups, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{
Status: pulumi.StringRef("OK"),
}, nil)
if err != nil {
return err
}
_, err = vpc.NewPublicIpAddressPool(ctx, "defaultPublicIpAddressPool", &vpc.PublicIpAddressPoolArgs{
Description: pulumi.String(name),
PublicIpAddressPoolName: pulumi.String(name),
Isp: pulumi.String("BGP"),
ResourceGroupId: *pulumi.String(defaultResourceGroups.Ids[0]),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.vpc.PublicIpAddressPool;
import com.pulumi.alicloud.vpc.PublicIpAddressPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var name = config.get("name").orElse("tf-example");
final var defaultResourceGroups = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
.status("OK")
.build());
var defaultPublicIpAddressPool = new PublicIpAddressPool("defaultPublicIpAddressPool", PublicIpAddressPoolArgs.builder()
.description(name)
.publicIpAddressPoolName(name)
.isp("BGP")
.resourceGroupId(defaultResourceGroups.applyValue(getResourceGroupsResult -> getResourceGroupsResult.ids()[0]))
.build());
}
}
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "tf-example"
default_resource_groups = alicloud.resourcemanager.get_resource_groups(status="OK")
default_public_ip_address_pool = alicloud.vpc.PublicIpAddressPool("defaultPublicIpAddressPool",
description=name,
public_ip_address_pool_name=name,
isp="BGP",
resource_group_id=default_resource_groups.ids[0])
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const defaultResourceGroups = alicloud.resourcemanager.getResourceGroups({
status: "OK",
});
const defaultPublicIpAddressPool = new alicloud.vpc.PublicIpAddressPool("defaultPublicIpAddressPool", {
description: name,
publicIpAddressPoolName: name,
isp: "BGP",
resourceGroupId: defaultResourceGroups.then(defaultResourceGroups => defaultResourceGroups.ids?.[0]),
});
configuration:
name:
type: string
default: tf-example
resources:
defaultPublicIpAddressPool:
type: alicloud:vpc:PublicIpAddressPool
properties:
description: ${name}
publicIpAddressPoolName: ${name}
isp: BGP
resourceGroupId: ${defaultResourceGroups.ids[0]}
variables:
defaultResourceGroups:
fn::invoke:
Function: alicloud:resourcemanager:getResourceGroups
Arguments:
status: OK
Create PublicIpAddressPool Resource
new PublicIpAddressPool(name: string, args?: PublicIpAddressPoolArgs, opts?: CustomResourceOptions);@overload
def PublicIpAddressPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
isp: Optional[str] = None,
public_ip_address_pool_name: Optional[str] = None,
resource_group_id: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None)
@overload
def PublicIpAddressPool(resource_name: str,
args: Optional[PublicIpAddressPoolArgs] = None,
opts: Optional[ResourceOptions] = None)func NewPublicIpAddressPool(ctx *Context, name string, args *PublicIpAddressPoolArgs, opts ...ResourceOption) (*PublicIpAddressPool, error)public PublicIpAddressPool(string name, PublicIpAddressPoolArgs? args = null, CustomResourceOptions? opts = null)
public PublicIpAddressPool(String name, PublicIpAddressPoolArgs args)
public PublicIpAddressPool(String name, PublicIpAddressPoolArgs args, CustomResourceOptions options)
type: alicloud:vpc:PublicIpAddressPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PublicIpAddressPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PublicIpAddressPoolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PublicIpAddressPoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PublicIpAddressPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PublicIpAddressPoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
PublicIpAddressPool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The PublicIpAddressPool resource accepts the following input properties:
- Description string
Description.
- Isp string
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- Public
Ip stringAddress Pool Name The name of the VPC Public IP address pool.
- Resource
Group stringId The resource group ID of the VPC Public IP address pool.
- Dictionary<string, object>
The tags of PrefixList.
- Description string
Description.
- Isp string
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- Public
Ip stringAddress Pool Name The name of the VPC Public IP address pool.
- Resource
Group stringId The resource group ID of the VPC Public IP address pool.
- map[string]interface{}
The tags of PrefixList.
- description String
Description.
- isp String
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- public
Ip StringAddress Pool Name The name of the VPC Public IP address pool.
- resource
Group StringId The resource group ID of the VPC Public IP address pool.
- Map<String,Object>
The tags of PrefixList.
- description string
Description.
- isp string
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- public
Ip stringAddress Pool Name The name of the VPC Public IP address pool.
- resource
Group stringId The resource group ID of the VPC Public IP address pool.
- {[key: string]: any}
The tags of PrefixList.
- description str
Description.
- isp str
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- public_
ip_ straddress_ pool_ name The name of the VPC Public IP address pool.
- resource_
group_ strid The resource group ID of the VPC Public IP address pool.
- Mapping[str, Any]
The tags of PrefixList.
- description String
Description.
- isp String
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- public
Ip StringAddress Pool Name The name of the VPC Public IP address pool.
- resource
Group StringId The resource group ID of the VPC Public IP address pool.
- Map<Any>
The tags of PrefixList.
Outputs
All input properties are implicitly available as output properties. Additionally, the PublicIpAddressPool resource produces the following output properties:
- Create
Time string The creation time of the resource.
- Id string
The provider-assigned unique ID for this managed resource.
- Ip
Address boolRemaining Whether there is a free IP address.
- Public
Ip stringAddress Pool Id - Status string
The status of the VPC Public IP address pool.
- Total
Ip intNum The total number of public IP address pools.
- Used
Ip intNum The number of used IP addresses in the public IP address pool.
- Create
Time string The creation time of the resource.
- Id string
The provider-assigned unique ID for this managed resource.
- Ip
Address boolRemaining Whether there is a free IP address.
- Public
Ip stringAddress Pool Id - Status string
The status of the VPC Public IP address pool.
- Total
Ip intNum The total number of public IP address pools.
- Used
Ip intNum The number of used IP addresses in the public IP address pool.
- create
Time String The creation time of the resource.
- id String
The provider-assigned unique ID for this managed resource.
- ip
Address BooleanRemaining Whether there is a free IP address.
- public
Ip StringAddress Pool Id - status String
The status of the VPC Public IP address pool.
- total
Ip IntegerNum The total number of public IP address pools.
- used
Ip IntegerNum The number of used IP addresses in the public IP address pool.
- create
Time string The creation time of the resource.
- id string
The provider-assigned unique ID for this managed resource.
- ip
Address booleanRemaining Whether there is a free IP address.
- public
Ip stringAddress Pool Id - status string
The status of the VPC Public IP address pool.
- total
Ip numberNum The total number of public IP address pools.
- used
Ip numberNum The number of used IP addresses in the public IP address pool.
- create_
time str The creation time of the resource.
- id str
The provider-assigned unique ID for this managed resource.
- ip_
address_ boolremaining Whether there is a free IP address.
- public_
ip_ straddress_ pool_ id - status str
The status of the VPC Public IP address pool.
- total_
ip_ intnum The total number of public IP address pools.
- used_
ip_ intnum The number of used IP addresses in the public IP address pool.
- create
Time String The creation time of the resource.
- id String
The provider-assigned unique ID for this managed resource.
- ip
Address BooleanRemaining Whether there is a free IP address.
- public
Ip StringAddress Pool Id - status String
The status of the VPC Public IP address pool.
- total
Ip NumberNum The total number of public IP address pools.
- used
Ip NumberNum The number of used IP addresses in the public IP address pool.
Look up Existing PublicIpAddressPool Resource
Get an existing PublicIpAddressPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PublicIpAddressPoolState, opts?: CustomResourceOptions): PublicIpAddressPool@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
ip_address_remaining: Optional[bool] = None,
isp: Optional[str] = None,
public_ip_address_pool_id: Optional[str] = None,
public_ip_address_pool_name: Optional[str] = None,
resource_group_id: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None,
total_ip_num: Optional[int] = None,
used_ip_num: Optional[int] = None) -> PublicIpAddressPoolfunc GetPublicIpAddressPool(ctx *Context, name string, id IDInput, state *PublicIpAddressPoolState, opts ...ResourceOption) (*PublicIpAddressPool, error)public static PublicIpAddressPool Get(string name, Input<string> id, PublicIpAddressPoolState? state, CustomResourceOptions? opts = null)public static PublicIpAddressPool get(String name, Output<String> id, PublicIpAddressPoolState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Create
Time string The creation time of the resource.
- Description string
Description.
- Ip
Address boolRemaining Whether there is a free IP address.
- Isp string
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- Public
Ip stringAddress Pool Id - Public
Ip stringAddress Pool Name The name of the VPC Public IP address pool.
- Resource
Group stringId The resource group ID of the VPC Public IP address pool.
- Status string
The status of the VPC Public IP address pool.
- Dictionary<string, object>
The tags of PrefixList.
- Total
Ip intNum The total number of public IP address pools.
- Used
Ip intNum The number of used IP addresses in the public IP address pool.
- Create
Time string The creation time of the resource.
- Description string
Description.
- Ip
Address boolRemaining Whether there is a free IP address.
- Isp string
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- Public
Ip stringAddress Pool Id - Public
Ip stringAddress Pool Name The name of the VPC Public IP address pool.
- Resource
Group stringId The resource group ID of the VPC Public IP address pool.
- Status string
The status of the VPC Public IP address pool.
- map[string]interface{}
The tags of PrefixList.
- Total
Ip intNum The total number of public IP address pools.
- Used
Ip intNum The number of used IP addresses in the public IP address pool.
- create
Time String The creation time of the resource.
- description String
Description.
- ip
Address BooleanRemaining Whether there is a free IP address.
- isp String
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- public
Ip StringAddress Pool Id - public
Ip StringAddress Pool Name The name of the VPC Public IP address pool.
- resource
Group StringId The resource group ID of the VPC Public IP address pool.
- status String
The status of the VPC Public IP address pool.
- Map<String,Object>
The tags of PrefixList.
- total
Ip IntegerNum The total number of public IP address pools.
- used
Ip IntegerNum The number of used IP addresses in the public IP address pool.
- create
Time string The creation time of the resource.
- description string
Description.
- ip
Address booleanRemaining Whether there is a free IP address.
- isp string
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- public
Ip stringAddress Pool Id - public
Ip stringAddress Pool Name The name of the VPC Public IP address pool.
- resource
Group stringId The resource group ID of the VPC Public IP address pool.
- status string
The status of the VPC Public IP address pool.
- {[key: string]: any}
The tags of PrefixList.
- total
Ip numberNum The total number of public IP address pools.
- used
Ip numberNum The number of used IP addresses in the public IP address pool.
- create_
time str The creation time of the resource.
- description str
Description.
- ip_
address_ boolremaining Whether there is a free IP address.
- isp str
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- public_
ip_ straddress_ pool_ id - public_
ip_ straddress_ pool_ name The name of the VPC Public IP address pool.
- resource_
group_ strid The resource group ID of the VPC Public IP address pool.
- status str
The status of the VPC Public IP address pool.
- Mapping[str, Any]
The tags of PrefixList.
- total_
ip_ intnum The total number of public IP address pools.
- used_
ip_ intnum The number of used IP addresses in the public IP address pool.
- create
Time String The creation time of the resource.
- description String
Description.
- ip
Address BooleanRemaining Whether there is a free IP address.
- isp String
The Internet service provider. Valid values:
BGP,BGP_PRO,ChinaTelecom,ChinaUnicom,ChinaMobile,ChinaTelecom_L2,ChinaUnicom_L2,ChinaMobile_L2,BGP_FinanceCloud. Default Value:BGP.- public
Ip StringAddress Pool Id - public
Ip StringAddress Pool Name The name of the VPC Public IP address pool.
- resource
Group StringId The resource group ID of the VPC Public IP address pool.
- status String
The status of the VPC Public IP address pool.
- Map<Any>
The tags of PrefixList.
- total
Ip NumberNum The total number of public IP address pools.
- used
Ip NumberNum The number of used IP addresses in the public IP address pool.
Import
Vpc Public Ip Address Pool can be imported using the id, e.g.
$ pulumi import alicloud:vpc/publicIpAddressPool:PublicIpAddressPool example <id>
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloudTerraform Provider.