provision_byoip_cidr¶
Operation¶
provision_byoip_cidr
¶
provision_byoip_cidr(request: ProvisionByoipCidrInput | ProvisionByoipCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ProvisionByoipCidrInputDict]) -> ProvisionByoipCidrOutput
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the call
returns immediately, but the address range is not ready to use until its
status changes from pending-provision to provisioned. For more
information, see Onboard your address
range.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ProvisionByoipCidrInput | ProvisionByoipCidrInputDict | 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[ProvisionByoipCidrInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ProvisionByoipCidrOutput
|
An instance of |
provision_byoip_cidr
async
¶
provision_byoip_cidr(request: ProvisionByoipCidrInput | ProvisionByoipCidrInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ProvisionByoipCidrInputDict]) -> ProvisionByoipCidrOutput
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the call
returns immediately, but the address range is not ready to use until its
status changes from pending-provision to provisioned. For more
information, see Onboard your address
range.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ProvisionByoipCidrInput | ProvisionByoipCidrInputDict | 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[ProvisionByoipCidrInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ProvisionByoipCidrOutput
|
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.
ProvisionByoipCidrInputDict
¶
Bases: TypedDict
Dictionary form of ProvisionByoipCidrInput.
Attributes¶
cidr
instance-attribute
¶
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
cidr_authorization_context
instance-attribute
¶
cidr_authorization_context: CidrAuthorizationContext | CidrAuthorizationContextDict | None
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
description
instance-attribute
¶
description: str | None
A description for the address range and the address pool.
dry_run
instance-attribute
¶
dry_run: bool | None
Checks 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
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
-
us-east-1-dfw-2
-
us-west-2-lax-1
-
us-west-2-phx-2
Note
You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
pool_tag_specifications
instance-attribute
¶
pool_tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to apply to the address pool.
ProvisionByoipCidrInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ProvisionByoipCidrInput structure.
Attributes¶
cidr
class-attribute
instance-attribute
¶
cidr: str | None = ...
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
cidr_authorization_context
class-attribute
instance-attribute
¶
cidr_authorization_context: CidrAuthorizationContext | None = ...
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the address range and the address pool.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks 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 = ...
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
-
us-east-1-dfw-2
-
us-west-2-lax-1
-
us-west-2-phx-2
Note
You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
pool_tag_specifications
class-attribute
instance-attribute
¶
pool_tag_specifications: list[TagSpecification] | None = ...
The tags to apply to the address pool.
Output¶
ProvisionByoipCidrOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ProvisionByoipCidrOutput structure.
Attributes¶
byoip_cidr
class-attribute
instance-attribute
¶
byoip_cidr: ByoipCidr | None = ...
Information about the address range.
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.