Skip to content

EC2  >  Operations  >  disassociate_nat_gateway_address

disassociate_nat_gateway_address

Operation

disassociate_nat_gateway_address async

disassociate_nat_gateway_address(request: DisassociateNatGatewayAddressInput | DisassociateNatGatewayAddressInputDict, /, *, plugins: list[Plugin] | None = None) -> DisassociateNatGatewayAddressOutput
disassociate_nat_gateway_address(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DisassociateNatGatewayAddressInputDict]) -> DisassociateNatGatewayAddressOutput

Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.

While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.

An EIP is released only at the end of MaxDrainDurationSeconds. It stays associated and supports the existing connections but does not support any new connections (new connections are distributed across the remaining associated EIPs). As the existing connections drain out, the EIPs (and the corresponding private IP addresses mapped to them) are released.

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
DisassociateNatGatewayAddressOutput

An instance of DisassociateNatGatewayAddressOutput.

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

DisassociateNatGatewayAddressInput dataclass

Bases: _SerdeShape

Dataclass for DisassociateNatGatewayAddressInput structure.

Attributes
association_ids class-attribute instance-attribute
association_ids: list[str] | None = ...

The association IDs of EIPs that have been associated with the NAT gateway.

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.

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

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

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

The ID of the NAT gateway.

Dictionaries

DisassociateNatGatewayAddressInputDict

Bases: TypedDict

Dictionary form of DisassociateNatGatewayAddressInput.

Attributes
association_ids instance-attribute
association_ids: Required[Sequence[str]]

The association IDs of EIPs that have been associated with the NAT gateway.

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.

max_drain_duration_seconds instance-attribute
max_drain_duration_seconds: int | None

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

nat_gateway_id instance-attribute
nat_gateway_id: Required[str]

The ID of the NAT gateway.

Output

DisassociateNatGatewayAddressOutput dataclass

Bases: _SerdeShape

Dataclass for DisassociateNatGatewayAddressOutput structure.

Attributes

nat_gateway_addresses class-attribute instance-attribute
nat_gateway_addresses: list[NatGatewayAddress] | None = ...

Information about the NAT gateway 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
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.