modify_ipam_pool¶
Operation¶
modify_ipam_pool
async
¶
modify_ipam_pool(request: ModifyIpamPoolInput | ModifyIpamPoolInputDict, /, *, plugins: list[Plugin] | None = None) -> ModifyIpamPoolOutput
modify_ipam_pool(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyIpamPoolInputDict]) -> ModifyIpamPoolOutput
Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
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 |
|---|---|
ModifyIpamPoolOutput
|
An instance of |
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¶
ModifyIpamPoolInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamPoolInput structure.
Attributes¶
add_allocation_resource_tags
class-attribute
instance-attribute
¶
add_allocation_resource_tags: list[RequestIpamResourceTag] | None = ...
Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
allocation_default_netmask_length
class-attribute
instance-attribute
¶
allocation_default_netmask_length: int | None = ...
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
allocation_max_netmask_length
class-attribute
instance-attribute
¶
allocation_max_netmask_length: int | None = ...
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.
allocation_min_netmask_length
class-attribute
instance-attribute
¶
allocation_min_netmask_length: int | None = ...
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.
auto_import
class-attribute
instance-attribute
¶
auto_import: bool | None = ...
If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
clear_allocation_default_netmask_length
class-attribute
instance-attribute
¶
clear_allocation_default_netmask_length: bool | None = ...
Clear the default netmask length allocation rule for this pool.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the IPAM pool you want to modify.
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 want to modify.
remove_allocation_resource_tags
class-attribute
instance-attribute
¶
remove_allocation_resource_tags: list[RequestIpamResourceTag] | None = ...
Remove tag allocation rules from a pool.
Dictionaries¶
ModifyIpamPoolInputDict
¶
Bases: TypedDict
Dictionary form of ModifyIpamPoolInput.
Attributes¶
add_allocation_resource_tags
instance-attribute
¶
add_allocation_resource_tags: Sequence[RequestIpamResourceTag | RequestIpamResourceTagDict] | None
Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
allocation_default_netmask_length
instance-attribute
¶
allocation_default_netmask_length: int | None
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
allocation_max_netmask_length
instance-attribute
¶
allocation_max_netmask_length: int | None
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.
allocation_min_netmask_length
instance-attribute
¶
allocation_min_netmask_length: int | None
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.
auto_import
instance-attribute
¶
auto_import: bool | None
If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
clear_allocation_default_netmask_length
instance-attribute
¶
clear_allocation_default_netmask_length: bool | None
Clear the default netmask length allocation rule for this pool.
description
instance-attribute
¶
description: str | None
The description of the IPAM pool you want to modify.
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 want to modify.
remove_allocation_resource_tags
instance-attribute
¶
remove_allocation_resource_tags: Sequence[RequestIpamResourceTag | RequestIpamResourceTagDict] | None
Remove tag allocation rules from a pool.
Output¶
ModifyIpamPoolOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIpamPoolOutput structure.
Attributes¶
ipam_pool
class-attribute
instance-attribute
¶
ipam_pool: IpamPool | None = ...
The results of the modification.
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.