Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. ec2
  6. getIPv4Pool

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.ec2.getIPv4Pool

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::EC2::IPv4Pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to AWS to manage with IPAM (BYOIP).

    Using getIPv4Pool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIPv4Pool(args: GetIPv4PoolArgs, opts?: InvokeOptions): Promise<GetIPv4PoolResult>
function getIPv4PoolOutput(args: GetIPv4PoolOutputArgs, opts?: InvokeOutputOptions): Output<GetIPv4PoolResult>
    def get_i_pv4_pool(arn: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetIPv4PoolResult
def get_i_pv4_pool_output(arn: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetIPv4PoolResult]
    func LookupIPv4Pool(ctx *Context, args *LookupIPv4PoolArgs, opts ...InvokeOption) (*LookupIPv4PoolResult, error)
func LookupIPv4PoolOutput(ctx *Context, args *LookupIPv4PoolOutputArgs, opts ...InvokeOption) LookupIPv4PoolResultOutput

    > Note: This function is named LookupIPv4Pool in the Go SDK.

    public static class GetIPv4Pool 
{
    public static Task<GetIPv4PoolResult> InvokeAsync(GetIPv4PoolArgs args, InvokeOptions? opts = null)
    public static Output<GetIPv4PoolResult> Invoke(GetIPv4PoolInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetIPv4PoolResult> Invoke(GetIPv4PoolInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetIPv4PoolResult> getIPv4Pool(GetIPv4PoolArgs args, InvokeOptions options)
public static Output<GetIPv4PoolResult> getIPv4Pool(GetIPv4PoolArgs args, InvokeOptions options)
public static Output<GetIPv4PoolResult> getIPv4Pool(GetIPv4PoolArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:ec2:getIPv4Pool
  arguments:
    # arguments dictionary
    data "aws-native_ec2_get_i_pv4_pool" "name" {
    # arguments
}

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    Arn string
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    arn string
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    arn String
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    arn string
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    arn str
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    arn String
    The Amazon Resource Name (ARN) of the public IPv4 pool.

    getIPv4Pool Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    Description string
    A description of the public IPv4 pool.
    NetworkBorderGroup string
    The name of the location from which the address pool is advertised.
    PoolId string
    The ID of the public IPv4 pool.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Any tags assigned to the public IPv4 pool.
    TotalAddressCount int
    The total number of addresses in the pool.
    TotalAvailableAddressCount int
    The total number of available addresses in the pool.
    Arn string
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    Description string
    A description of the public IPv4 pool.
    NetworkBorderGroup string
    The name of the location from which the address pool is advertised.
    PoolId string
    The ID of the public IPv4 pool.
    Tags Tag
    Any tags assigned to the public IPv4 pool.
    TotalAddressCount int
    The total number of addresses in the pool.
    TotalAvailableAddressCount int
    The total number of available addresses in the pool.
    arn string
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    description string
    A description of the public IPv4 pool.
    network_border_group string
    The name of the location from which the address pool is advertised.
    pool_id string
    The ID of the public IPv4 pool.
    tags list(object)
    Any tags assigned to the public IPv4 pool.
    total_address_count number
    The total number of addresses in the pool.
    total_available_address_count number
    The total number of available addresses in the pool.
    arn String
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    description String
    A description of the public IPv4 pool.
    networkBorderGroup String
    The name of the location from which the address pool is advertised.
    poolId String
    The ID of the public IPv4 pool.
    tags List<Tag>
    Any tags assigned to the public IPv4 pool.
    totalAddressCount Integer
    The total number of addresses in the pool.
    totalAvailableAddressCount Integer
    The total number of available addresses in the pool.
    arn string
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    description string
    A description of the public IPv4 pool.
    networkBorderGroup string
    The name of the location from which the address pool is advertised.
    poolId string
    The ID of the public IPv4 pool.
    tags Tag[]
    Any tags assigned to the public IPv4 pool.
    totalAddressCount number
    The total number of addresses in the pool.
    totalAvailableAddressCount number
    The total number of available addresses in the pool.
    arn str
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    description str
    A description of the public IPv4 pool.
    network_border_group str
    The name of the location from which the address pool is advertised.
    pool_id str
    The ID of the public IPv4 pool.
    tags Sequence[root_Tag]
    Any tags assigned to the public IPv4 pool.
    total_address_count int
    The total number of addresses in the pool.
    total_available_address_count int
    The total number of available addresses in the pool.
    arn String
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    description String
    A description of the public IPv4 pool.
    networkBorderGroup String
    The name of the location from which the address pool is advertised.
    poolId String
    The ID of the public IPv4 pool.
    tags List<Property Map>
    Any tags assigned to the public IPv4 pool.
    totalAddressCount Number
    The total number of addresses in the pool.
    totalAvailableAddressCount Number
    The total number of available addresses in the pool.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial