Skip to content

EC2  >  Structures  >  NatGateway

NatGateway

Structure Class

NatGateway dataclass

Bases: _SerdeShape

Describes a NAT gateway.

Attributes

attached_appliances class-attribute instance-attribute
attached_appliances: list[NatGatewayAttachedAppliance] | None = ...

The proxy appliances attached to the NAT Gateway for filtering and inspecting traffic to prevent data exfiltration.

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

For regional NAT gateways only: Indicates whether Amazon Web Services automatically manages AZ coverage. When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.

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.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

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

For regional NAT gateways only: Indicates whether Amazon Web Services automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

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

Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. 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.

For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

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

Indicates whether the NAT gateway supports public or private connectivity.

create_time class-attribute instance-attribute
create_time: datetime | None = ...

The date and time the NAT gateway was created.

delete_time class-attribute instance-attribute
delete_time: datetime | None = ...

The date and time the NAT gateway was deleted, if applicable.

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

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

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

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"

  • For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"

  • For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"

  • For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"

  • For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."

  • For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."

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

Information about the IP addresses and network interface associated with the NAT gateway.

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

The ID of the NAT gateway.

provisioned_bandwidth class-attribute instance-attribute
provisioned_bandwidth: ProvisionedBandwidth | None = ...

Reserved. If you need to sustain traffic greater than the documented limits, contact Amazon Web Services Support.

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

For regional NAT gateways only, this is the ID of the NAT gateway.

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

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

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

The ID of the subnet in which the NAT gateway is located.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

The tags for the NAT gateway.

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

The ID of the VPC in which the NAT gateway is located.