Disassociate Nat Gateway Address

ec2_disassociate_nat_gateway_address

R Documentation

Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway¶

Description¶

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.

Usage¶

ec2_disassociate_nat_gateway_address(NatGatewayId, AssociationIds,
  MaxDrainDurationSeconds, DryRun)

Arguments¶

NatGatewayId: [required] The ID of the NAT gateway.
AssociationIds: [required] The association IDs of EIPs that have been associated with the NAT gateway.
MaxDrainDurationSeconds: 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.
DryRun: 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.

Value¶

A list with the following syntax:

list(
  NatGatewayId = "string",
  NatGatewayAddresses = list(
    list(
      AllocationId = "string",
      NetworkInterfaceId = "string",
      PrivateIp = "string",
      PublicIp = "string",
      AssociationId = "string",
      IsPrimary = TRUE|FALSE,
      FailureMessage = "string",
      Status = "assigning"|"unassigning"|"associating"|"disassociating"|"succeeded"|"failed"
    )
  )
)

Request syntax¶

svc$disassociate_nat_gateway_address(
  NatGatewayId = "string",
  AssociationIds = list(
    "string"
  ),
  MaxDrainDurationSeconds = 123,
  DryRun = TRUE|FALSE
)