aws_vpc_nat_gateway

account_id

Type: STRING

attached_appliances

Type: UNORDERED_LIST_STRUCT
Provider name: AttachedAppliances
Description: The proxy appliances attached to the NAT Gateway for filtering and inspecting traffic to prevent data exfiltration.

• appliance_arn
  Type: STRING
  Provider name: ApplianceArn
  Description: The Amazon Resource Name (ARN) of the attached appliance, identifying the specific proxy or security appliance resource.
  
• attachment_state
  Type: STRING
  Provider name: AttachmentState
  Description: The current attachment state of the appliance.
  
• failure_code
  Type: STRING
  Provider name: FailureCode
  Description: The failure code if the appliance attachment or modification operation failed.
  
• failure_message
  Type: STRING
  Provider name: FailureMessage
  Description: A descriptive message explaining the failure if the appliance attachment or modification operation failed.
  
• modification_state
  Type: STRING
  Provider name: ModificationState
  Description: The current modification state of the appliance.
  
• type
  Type: STRING
  Provider name: Type
  Description: The type of appliance attached to the NAT Gateway. For network firewall proxy functionality, this will be “network-firewall-proxy”.
  
• vpc_endpoint_id
  Type: STRING
  Provider name: VpcEndpointId
  Description: The VPC endpoint ID used to route traffic from application VPCs to the proxy for inspection and filtering.
  

auto_provision_zones

Type: STRING
Provider name: AutoProvisionZones
Description: 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

Type: STRING
Provider name: AutoScalingIps
Description: 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

Type: STRING
Provider name: AvailabilityMode
Description: 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

Type: STRING
Provider name: ConnectivityType
Description: Indicates whether the NAT gateway supports public or private connectivity.

create_time

Type: TIMESTAMP
Provider name: CreateTime
Description: The date and time the NAT gateway was created.

delete_time

Type: TIMESTAMP
Provider name: DeleteTime
Description: The date and time the NAT gateway was deleted, if applicable.

failure_code

Type: STRING
Provider name: FailureCode
Description: 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

Type: STRING
Provider name: FailureMessage
Description: 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

Type: UNORDERED_LIST_STRUCT
Provider name: NatGatewayAddresses
Description: Information about the IP addresses and network interface associated with the NAT gateway.

• allocation_id
  Type: STRING
  Provider name: AllocationId
  Description: [Public NAT gateway only] The allocation ID of the Elastic IP address that’s associated with the NAT gateway.
  
• association_id
  Type: STRING
  Provider name: AssociationId
  Description: [Public NAT gateway only] The association ID of the Elastic IP address that’s associated with the NAT gateway.
  
• availability_zone
  Type: STRING
  Provider name: AvailabilityZone
  Description: The Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic.
  
• availability_zone_id
  Type: STRING
  Provider name: AvailabilityZoneId
  Description: The ID of the Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic. Use this instead of AvailabilityZone for consistent identification of AZs across Amazon Web Services Regions.
  
• failure_message
  Type: STRING
  Provider name: FailureMessage
  Description: The address failure message.
  
• is_primary
  Type: BOOLEAN
  Provider name: IsPrimary
  Description: Defines if the IP address is the primary address.
  
• network_interface_id
  Type: STRING
  Provider name: NetworkInterfaceId
  Description: The ID of the network interface associated with the NAT gateway.
  
• private_ip
  Type: STRING
  Provider name: PrivateIp
  Description: The private IP address associated with the NAT gateway.
  
• public_ip
  Type: STRING
  Provider name: PublicIp
  Description: [Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
  
• status
  Type: STRING
  Provider name: Status
  Description: The address status.
  

nat_gateway_arn

Type: STRING

nat_gateway_id

Type: STRING
Provider name: NatGatewayId
Description: The ID of the NAT gateway.

provisioned_bandwidth

Type: STRUCT
Provider name: ProvisionedBandwidth
Description: Reserved. If you need to sustain traffic greater than the documented limits, contact Amazon Web Services Support.

• provision_time
  Type: TIMESTAMP
  Provider name: ProvisionTime
  Description: Reserved.
  
• provisioned
  Type: STRING
  Provider name: Provisioned
  Description: Reserved.
  
• request_time
  Type: TIMESTAMP
  Provider name: RequestTime
  Description: Reserved.
  
• requested
  Type: STRING
  Provider name: Requested
  Description: Reserved.
  
• status
  Type: STRING
  Provider name: Status
  Description: Reserved.
  

route_table_id

Type: STRING
Provider name: RouteTableId
Description: For regional NAT gateways only, this is the ID of the NAT gateway.

state

Type: STRING
Provider name: State
Description: 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

Type: STRING
Provider name: SubnetId
Description: The ID of the subnet in which the NAT gateway is located.

tags

Type: UNORDERED_LIST_STRING

vpc_id

Type: STRING
Provider name: VpcId
Description: The ID of the VPC in which the NAT gateway is located.