Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. vpc
  5. PublicIpAddressPool
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.vpc.PublicIpAddressPool

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

    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

    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 default = alicloud.resourcemanager.getResourceGroups({
    status: "OK",
});
const defaultPublicIpAddressPool = new alicloud.vpc.PublicIpAddressPool("default", {
    description: name,
    publicIpAddressPoolName: name,
    isp: "BGP",
    resourceGroupId: _default.then(_default => _default.ids?.[0]),
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf-example"
default = alicloud.resourcemanager.get_resource_groups(status="OK")
default_public_ip_address_pool = alicloud.vpc.PublicIpAddressPool("default",
    description=name,
    public_ip_address_pool_name=name,
    isp="BGP",
    resource_group_id=default.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
		}
		_default, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{
			Status: pulumi.StringRef("OK"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vpc.NewPublicIpAddressPool(ctx, "default", &vpc.PublicIpAddressPoolArgs{
			Description:             pulumi.String(name),
			PublicIpAddressPoolName: pulumi.String(name),
			Isp:                     pulumi.String("BGP"),
			ResourceGroupId:         pulumi.String(_default.Ids[0]),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 @default = AliCloud.ResourceManager.GetResourceGroups.Invoke(new()
    {
        Status = "OK",
    });

    var defaultPublicIpAddressPool = new AliCloud.Vpc.PublicIpAddressPool("default", new()
    {
        Description = name,
        PublicIpAddressPoolName = name,
        Isp = "BGP",
        ResourceGroupId = @default.Apply(@default => @default.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[0])),
    });

});

    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 default = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
            .status("OK")
            .build());

        var defaultPublicIpAddressPool = new PublicIpAddressPool("defaultPublicIpAddressPool", PublicIpAddressPoolArgs.builder()
            .description(name)
            .publicIpAddressPoolName(name)
            .isp("BGP")
            .resourceGroupId(default_.ids()[0])
            .build());

    }
}

    configuration:
  name:
    type: string
    default: tf-example
resources:
  defaultPublicIpAddressPool:
    type: alicloud:vpc:PublicIpAddressPool
    name: default
    properties:
      description: ${name}
      publicIpAddressPoolName: ${name}
      isp: BGP
      resourceGroupId: ${default.ids[0]}
variables:
  default:
    fn::invoke:
      Function: alicloud:resourcemanager:getResourceGroups
      Arguments:
        status: OK

    Create PublicIpAddressPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PublicIpAddressPool(name: string, args?: PublicIpAddressPoolArgs, opts?: CustomResourceOptions);
    @overload
def PublicIpAddressPool(resource_name: str,
                        args: Optional[PublicIpAddressPoolArgs] = None,
                        opts: Optional[ResourceOptions] = None)

@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)
    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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var publicIpAddressPoolResource = new AliCloud.Vpc.PublicIpAddressPool("publicIpAddressPoolResource", new()
{
    Description = "string",
    Isp = "string",
    PublicIpAddressPoolName = "string",
    ResourceGroupId = "string",
    Tags = 
    {
        { "string", "any" },
    },
});

    example, err := vpc.NewPublicIpAddressPool(ctx, "publicIpAddressPoolResource", &vpc.PublicIpAddressPoolArgs{
	Description:             pulumi.String("string"),
	Isp:                     pulumi.String("string"),
	PublicIpAddressPoolName: pulumi.String("string"),
	ResourceGroupId:         pulumi.String("string"),
	Tags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
})

    var publicIpAddressPoolResource = new PublicIpAddressPool("publicIpAddressPoolResource", PublicIpAddressPoolArgs.builder()
    .description("string")
    .isp("string")
    .publicIpAddressPoolName("string")
    .resourceGroupId("string")
    .tags(Map.of("string", "any"))
    .build());

    public_ip_address_pool_resource = alicloud.vpc.PublicIpAddressPool("publicIpAddressPoolResource",
    description="string",
    isp="string",
    public_ip_address_pool_name="string",
    resource_group_id="string",
    tags={
        "string": "any",
    })

    const publicIpAddressPoolResource = new alicloud.vpc.PublicIpAddressPool("publicIpAddressPoolResource", {
    description: "string",
    isp: "string",
    publicIpAddressPoolName: "string",
    resourceGroupId: "string",
    tags: {
        string: "any",
    },
});

    type: alicloud:vpc:PublicIpAddressPool
properties:
    description: string
    isp: string
    publicIpAddressPoolName: string
    resourceGroupId: string
    tags:
        string: any

    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.
    PublicIpAddressPoolName string
    The name of the VPC Public IP address pool.
    ResourceGroupId string
    The resource group ID of the VPC Public IP address pool.
    Tags 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.
    PublicIpAddressPoolName string
    The name of the VPC Public IP address pool.
    ResourceGroupId string
    The resource group ID of the VPC Public IP address pool.
    Tags 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.
    publicIpAddressPoolName String
    The name of the VPC Public IP address pool.
    resourceGroupId String
    The resource group ID of the VPC Public IP address pool.
    tags 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.
    publicIpAddressPoolName string
    The name of the VPC Public IP address pool.
    resourceGroupId string
    The resource group ID of the VPC Public IP address pool.
    tags {[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_address_pool_name str
    The name of the VPC Public IP address pool.
    resource_group_id str
    The resource group ID of the VPC Public IP address pool.
    tags 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.
    publicIpAddressPoolName String
    The name of the VPC Public IP address pool.
    resourceGroupId String
    The resource group ID of the VPC Public IP address pool.
    tags 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:

    CreateTime string
    The creation time of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddressRemaining bool
    Whether there is a free IP address.
    PublicIpAddressPoolId string
    Status string
    The status of the VPC Public IP address pool.
    TotalIpNum int
    The total number of public IP address pools.
    UsedIpNum int
    The number of used IP addresses in the public IP address pool.
    CreateTime string
    The creation time of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddressRemaining bool
    Whether there is a free IP address.
    PublicIpAddressPoolId string
    Status string
    The status of the VPC Public IP address pool.
    TotalIpNum int
    The total number of public IP address pools.
    UsedIpNum int
    The number of used IP addresses in the public IP address pool.
    createTime String
    The creation time of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddressRemaining Boolean
    Whether there is a free IP address.
    publicIpAddressPoolId String
    status String
    The status of the VPC Public IP address pool.
    totalIpNum Integer
    The total number of public IP address pools.
    usedIpNum Integer
    The number of used IP addresses in the public IP address pool.
    createTime string
    The creation time of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddressRemaining boolean
    Whether there is a free IP address.
    publicIpAddressPoolId string
    status string
    The status of the VPC Public IP address pool.
    totalIpNum number
    The total number of public IP address pools.
    usedIpNum number
    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_remaining bool
    Whether there is a free IP address.
    public_ip_address_pool_id str
    status str
    The status of the VPC Public IP address pool.
    total_ip_num int
    The total number of public IP address pools.
    used_ip_num int
    The number of used IP addresses in the public IP address pool.
    createTime String
    The creation time of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddressRemaining Boolean
    Whether there is a free IP address.
    publicIpAddressPoolId String
    status String
    The status of the VPC Public IP address pool.
    totalIpNum Number
    The total number of public IP address pools.
    usedIpNum Number
    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) -> PublicIpAddressPool
    func 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.
    The following state arguments are supported:
    CreateTime string
    The creation time of the resource.
    Description string
    Description.
    IpAddressRemaining bool
    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.
    PublicIpAddressPoolId string
    PublicIpAddressPoolName string
    The name of the VPC Public IP address pool.
    ResourceGroupId string
    The resource group ID of the VPC Public IP address pool.
    Status string
    The status of the VPC Public IP address pool.
    Tags Dictionary<string, object>
    The tags of PrefixList.
    TotalIpNum int
    The total number of public IP address pools.
    UsedIpNum int
    The number of used IP addresses in the public IP address pool.
    CreateTime string
    The creation time of the resource.
    Description string
    Description.
    IpAddressRemaining bool
    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.
    PublicIpAddressPoolId string
    PublicIpAddressPoolName string
    The name of the VPC Public IP address pool.
    ResourceGroupId string
    The resource group ID of the VPC Public IP address pool.
    Status string
    The status of the VPC Public IP address pool.
    Tags map[string]interface{}
    The tags of PrefixList.
    TotalIpNum int
    The total number of public IP address pools.
    UsedIpNum int
    The number of used IP addresses in the public IP address pool.
    createTime String
    The creation time of the resource.
    description String
    Description.
    ipAddressRemaining Boolean
    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.
    publicIpAddressPoolId String
    publicIpAddressPoolName String
    The name of the VPC Public IP address pool.
    resourceGroupId String
    The resource group ID of the VPC Public IP address pool.
    status String
    The status of the VPC Public IP address pool.
    tags Map<String,Object>
    The tags of PrefixList.
    totalIpNum Integer
    The total number of public IP address pools.
    usedIpNum Integer
    The number of used IP addresses in the public IP address pool.
    createTime string
    The creation time of the resource.
    description string
    Description.
    ipAddressRemaining boolean
    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.
    publicIpAddressPoolId string
    publicIpAddressPoolName string
    The name of the VPC Public IP address pool.
    resourceGroupId string
    The resource group ID of the VPC Public IP address pool.
    status string
    The status of the VPC Public IP address pool.
    tags {[key: string]: any}
    The tags of PrefixList.
    totalIpNum number
    The total number of public IP address pools.
    usedIpNum number
    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_remaining bool
    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_address_pool_id str
    public_ip_address_pool_name str
    The name of the VPC Public IP address pool.
    resource_group_id str
    The resource group ID of the VPC Public IP address pool.
    status str
    The status of the VPC Public IP address pool.
    tags Mapping[str, Any]
    The tags of PrefixList.
    total_ip_num int
    The total number of public IP address pools.
    used_ip_num int
    The number of used IP addresses in the public IP address pool.
    createTime String
    The creation time of the resource.
    description String
    Description.
    ipAddressRemaining Boolean
    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.
    publicIpAddressPoolId String
    publicIpAddressPoolName String
    The name of the VPC Public IP address pool.
    resourceGroupId String
    The resource group ID of the VPC Public IP address pool.
    status String
    The status of the VPC Public IP address pool.
    tags Map<Any>
    The tags of PrefixList.
    totalIpNum Number
    The total number of public IP address pools.
    usedIpNum Number
    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>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-alicloud