Skip to content

EC2  >  Operations  >  provision_ipam_pool_cidr

provision_ipam_pool_cidr

Operation

provision_ipam_pool_cidr async

provision_ipam_pool_cidr(request: ProvisionIpamPoolCidrInput | ProvisionIpamPoolCidrInputDict, /, *, plugins: list[Plugin] | None = None) -> ProvisionIpamPoolCidrOutput
provision_ipam_pool_cidr(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ProvisionIpamPoolCidrInputDict]) -> ProvisionIpamPoolCidrOutput

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

For more information, see Provision CIDRs to pools 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
ProvisionIpamPoolCidrOutput

An instance of ProvisionIpamPoolCidrOutput.

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

ProvisionIpamPoolCidrInput dataclass

Bases: _SerdeShape

Dataclass for ProvisionIpamPoolCidrInput structure.

Attributes
cidr class-attribute instance-attribute
cidr: str | None = ...

The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.

cidr_authorization_context class-attribute instance-attribute
cidr_authorization_context: IpamCidrAuthorizationContext | None = ...

A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

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_external_resource_verification_token_id class-attribute instance-attribute
ipam_external_resource_verification_token_id: str | None = ...

Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.

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

The ID of the IPAM pool to which you want to assign a CIDR.

netmask_length class-attribute instance-attribute
netmask_length: int | None = ...

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.

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

The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.

Dictionaries

ProvisionIpamPoolCidrInputDict

Bases: TypedDict

Dictionary form of ProvisionIpamPoolCidrInput.

Attributes
cidr instance-attribute
cidr: str | None

The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.

cidr_authorization_context instance-attribute

A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

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_external_resource_verification_token_id instance-attribute
ipam_external_resource_verification_token_id: str | None

Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.

ipam_pool_id instance-attribute
ipam_pool_id: Required[str]

The ID of the IPAM pool to which you want to assign a CIDR.

netmask_length instance-attribute
netmask_length: int | None

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.

verification_method instance-attribute
verification_method: str | None

The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.

Output

ProvisionIpamPoolCidrOutput dataclass

Bases: _SerdeShape

Dataclass for ProvisionIpamPoolCidrOutput structure.

Attributes

ipam_pool_cidr class-attribute instance-attribute
ipam_pool_cidr: IpamPoolCidr | None = ...

Information about the provisioned CIDR.

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.