provision_public_ipv4_pool_cidr¶
Operation¶
provision_public_ipv4_pool_cidr
¶
provision_public_ipv4_pool_cidr(request: ProvisionPublicIpv4PoolCidrInput | ProvisionPublicIpv4PoolCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ProvisionPublicIpv4PoolCidrInputDict]) -> ProvisionPublicIpv4PoolCidrOutput
Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ProvisionPublicIpv4PoolCidrInput | ProvisionPublicIpv4PoolCidrInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ProvisionPublicIpv4PoolCidrInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ProvisionPublicIpv4PoolCidrOutput
|
An instance of |
provision_public_ipv4_pool_cidr
async
¶
provision_public_ipv4_pool_cidr(request: ProvisionPublicIpv4PoolCidrInput | ProvisionPublicIpv4PoolCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ProvisionPublicIpv4PoolCidrInputDict]) -> ProvisionPublicIpv4PoolCidrOutput
Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ProvisionPublicIpv4PoolCidrInput | ProvisionPublicIpv4PoolCidrInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ProvisionPublicIpv4PoolCidrInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ProvisionPublicIpv4PoolCidrOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ProvisionPublicIpv4PoolCidrInputDict
¶
Bases: TypedDict
Dictionary form of ProvisionPublicIpv4PoolCidrInput.
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.
ipam_pool_id
instance-attribute
¶
The ID of the IPAM pool you would like to use to allocate this CIDR.
netmask_length
instance-attribute
¶
The netmask length of the CIDR you would like to allocate to the public IPv4 pool. The least specific netmask length you can define is 24.
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.
ProvisionPublicIpv4PoolCidrInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ProvisionPublicIpv4PoolCidrInput 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.
ipam_pool_id
class-attribute
instance-attribute
¶
ipam_pool_id: str | None = ...
The ID of the IPAM pool you would like to use to allocate this CIDR.
netmask_length
class-attribute
instance-attribute
¶
netmask_length: int | None = ...
The netmask length of the CIDR you would like to allocate to the public IPv4 pool. The least specific netmask length you can define is 24.
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.
Output¶
ProvisionPublicIpv4PoolCidrOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ProvisionPublicIpv4PoolCidrOutput structure.
Attributes¶
pool_address_range
class-attribute
instance-attribute
¶
pool_address_range: PublicIpv4PoolRange | None = ...
Information about the address range of the public IPv4 pool.
pool_id
class-attribute
instance-attribute
¶
pool_id: str | None = ...
The ID of the pool that you want to provision the CIDR to.
response_metadata
class-attribute
instance-attribute
¶
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.