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

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.IPv4Pool

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

    Create IPv4Pool Resource

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

    Constructor syntax

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

@overload
def IPv4Pool(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewIPv4Pool(ctx *Context, name string, args *IPv4PoolArgs, opts ...ResourceOption) (*IPv4Pool, error)
    public IPv4Pool(string name, IPv4PoolArgs? args = null, CustomResourceOptions? opts = null)
    public IPv4Pool(String name, IPv4PoolArgs args)
public IPv4Pool(String name, IPv4PoolArgs args, CustomResourceOptions options)

    type: aws-native:ec2:IPv4Pool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws-native_ec2_i_pv4_pool" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IPv4PoolArgs
    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 IPv4PoolArgs
    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 IPv4PoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IPv4PoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IPv4PoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    IPv4Pool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IPv4Pool resource accepts the following input properties:

    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Any tags assigned to the public IPv4 pool.
    Tags TagArgs
    Any tags assigned to the public IPv4 pool.
    tags list(object)
    Any tags assigned to the public IPv4 pool.
    tags List<Tag>
    Any tags assigned to the public IPv4 pool.
    tags Tag[]
    Any tags assigned to the public IPv4 pool.
    tags Sequence[TagArgs]
    Any tags assigned to the public IPv4 pool.
    tags List<Property Map>
    Any tags assigned to the public IPv4 pool.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IPv4Pool resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the public IPv4 pool.
    Description string
    A description of the public IPv4 pool.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkBorderGroup string
    The name of the location from which the address pool is advertised.
    PoolId string
    The ID of 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkBorderGroup string
    The name of the location from which the address pool is advertised.
    PoolId string
    The ID of 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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    networkBorderGroup String
    The name of the location from which the address pool is advertised.
    poolId String
    The ID of 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.
    id string
    The provider-assigned unique ID for this managed resource.
    networkBorderGroup string
    The name of the location from which the address pool is advertised.
    poolId string
    The ID of 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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    networkBorderGroup String
    The name of the location from which the address pool is advertised.
    poolId String
    The ID of 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, TagArgs

    A set of tags to apply to the resource.
    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