Skip to content

EC2  >  Operations  >  create_public_ipv4_pool

create_public_ipv4_pool

Operation

create_public_ipv4_pool async

create_public_ipv4_pool(request: CreatePublicIpv4PoolInput | CreatePublicIpv4PoolInputDict, /, *, plugins: list[Plugin] | None = None) -> CreatePublicIpv4PoolOutput
create_public_ipv4_pool(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePublicIpv4PoolInputDict]) -> CreatePublicIpv4PoolOutput

Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreatePublicIpv4PoolOutput

An instance of CreatePublicIpv4PoolOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreatePublicIpv4PoolInput dataclass

Bases: _SerdeShape

Dataclass for CreatePublicIpv4PoolInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

network_border_group class-attribute instance-attribute
network_border_group: str | None = ...

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Dictionaries

CreatePublicIpv4PoolInputDict

Bases: TypedDict

Dictionary form of CreatePublicIpv4PoolInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

network_border_group instance-attribute
network_border_group: str | None

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Output

CreatePublicIpv4PoolOutput dataclass

Bases: _SerdeShape

Dataclass for CreatePublicIpv4PoolOutput structure.

Attributes

pool_id class-attribute instance-attribute
pool_id: str | None = ...

The ID of the public IPv4 pool.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.