associate_nat_gateway_address¶
Operation¶
associate_nat_gateway_address
async
¶
associate_nat_gateway_address(request: AssociateNatGatewayAddressInput | AssociateNatGatewayAddressInputDict, /, *, plugins: list[Plugin] | None = None) -> AssociateNatGatewayAddressOutput
associate_nat_gateway_address(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssociateNatGatewayAddressInputDict]) -> AssociateNatGatewayAddressOutput
Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
Warning
When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC 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 |
|---|---|
AssociateNatGatewayAddressOutput
|
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¶
AssociateNatGatewayAddressInput
dataclass
¶
Bases: _SerdeShape
Dataclass for AssociateNatGatewayAddressInput structure.
Attributes¶
allocation_ids
class-attribute
instance-attribute
¶
The allocation IDs of EIPs that you want to associate with your NAT gateway.
availability_zone
class-attribute
instance-attribute
¶
availability_zone: str | None = ...
For regional NAT gateways only: The Availability Zone where you want to associate an Elastic IP address (EIP). The regional NAT gateway uses a separate EIP in each AZ to handle outbound NAT traffic from that AZ.
A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.
availability_zone_id
class-attribute
instance-attribute
¶
availability_zone_id: str | None = ...
For regional NAT gateways only: The ID of the Availability Zone where you want to associate an Elastic IP address (EIP). The regional NAT gateway uses a separate EIP in each AZ to handle outbound NAT traffic from that AZ. Use this instead of AvailabilityZone for consistent identification of AZs across Amazon Web Services Regions.
A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.
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.
Dictionaries¶
AssociateNatGatewayAddressInputDict
¶
Bases: TypedDict
Dictionary form of AssociateNatGatewayAddressInput.
Attributes¶
allocation_ids
instance-attribute
¶
The allocation IDs of EIPs that you want to associate with your NAT gateway.
availability_zone
instance-attribute
¶
availability_zone: str | None
For regional NAT gateways only: The Availability Zone where you want to associate an Elastic IP address (EIP). The regional NAT gateway uses a separate EIP in each AZ to handle outbound NAT traffic from that AZ.
A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.
availability_zone_id
instance-attribute
¶
availability_zone_id: str | None
For regional NAT gateways only: The ID of the Availability Zone where you want to associate an Elastic IP address (EIP). The regional NAT gateway uses a separate EIP in each AZ to handle outbound NAT traffic from that AZ. Use this instead of AvailabilityZone for consistent identification of AZs across Amazon Web Services Regions.
A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.
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.
Output¶
AssociateNatGatewayAddressOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for AssociateNatGatewayAddressOutput structure.
Attributes¶
nat_gateway_addresses
class-attribute
instance-attribute
¶
nat_gateway_addresses: list[NatGatewayAddress] | None = ...
The IP addresses.
nat_gateway_id
class-attribute
instance-attribute
¶
nat_gateway_id: str | None = ...
The ID of the NAT gateway.
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.