Class: Aws::EC2::Types::NatGateway

Inherits:

Struct

Object
Struct
Aws::EC2::Types::NatGateway

show all

Defined in:: gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Describes a NAT gateway.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attached_appliances ⇒ Array<Types::NatGatewayAttachedAppliance>
The proxy appliances attached to the NAT Gateway for filtering and inspecting traffic to prevent data exfiltration.
#auto_provision_zones ⇒ String
For regional NAT gateways only: Indicates whether Amazon Web Services automatically manages AZ coverage.
#auto_scaling_ips ⇒ String
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.
#availability_mode ⇒ String
Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.
#connectivity_type ⇒ String
Indicates whether the NAT gateway supports public or private connectivity.
#create_time ⇒ Time
The date and time the NAT gateway was created.
#delete_time ⇒ Time
The date and time the NAT gateway was deleted, if applicable.
#failure_code ⇒ String
If the NAT gateway could not be created, specifies the error code for the failure.
#failure_message ⇒ String
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
#nat_gateway_addresses ⇒ Array<Types::NatGatewayAddress>
Information about the IP addresses and network interface associated with the NAT gateway.
#nat_gateway_id ⇒ String
The ID of the NAT gateway.
#provisioned_bandwidth ⇒ Types::ProvisionedBandwidth
Reserved.
#route_table_id ⇒ String
For regional NAT gateways only, this is the ID of the NAT gateway.
#state ⇒ String
The state of the NAT gateway.
#subnet_id ⇒ String
The ID of the subnet in which the NAT gateway is located.
#tags ⇒ Array<Types::Tag>
The tags for the NAT gateway.
#vpc_id ⇒ String
The ID of the VPC in which the NAT gateway is located.

Instance Attribute Details

#attached_appliances ⇒ `Array<Types::NatGatewayAttachedAppliance>`

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

Returns:

(Array<Types::NatGatewayAttachedAppliance>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#auto_provision_zones ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#auto_scaling_ips ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#availability_mode ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#connectivity_type ⇒ `String`

Indicates whether the NAT gateway supports public or private connectivity.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ `Time`

The date and time the NAT gateway was created.

Returns:

(Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#delete_time ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#failure_code ⇒ `String`

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#failure_message ⇒ `String`

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."

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#nat_gateway_addresses ⇒ `Array<Types::NatGatewayAddress>`

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

Returns:

(Array<Types::NatGatewayAddress>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#nat_gateway_id ⇒ `String`

The ID of the NAT gateway.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_bandwidth ⇒ `Types::ProvisionedBandwidth`

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

Returns:

(Types::ProvisionedBandwidth)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#route_table_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The tags for the NAT gateway.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 64910

class NatGateway < Struct.new(
  :create_time,
  :delete_time,
  :failure_code,
  :failure_message,
  :nat_gateway_addresses,
  :nat_gateway_id,
  :provisioned_bandwidth,
  :state,
  :subnet_id,
  :vpc_id,
  :tags,
  :connectivity_type,
  :availability_mode,
  :auto_scaling_ips,
  :auto_provision_zones,
  :attached_appliances,
  :route_table_id)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::EC2::Types::NatGateway

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#attached_appliances ⇒ Array<Types::NatGatewayAttachedAppliance>

#auto_provision_zones ⇒ String

#auto_scaling_ips ⇒ String

#availability_mode ⇒ String

#connectivity_type ⇒ String

#create_time ⇒ Time

#delete_time ⇒ Time

#failure_code ⇒ String

#failure_message ⇒ String

#nat_gateway_addresses ⇒ Array<Types::NatGatewayAddress>

#nat_gateway_id ⇒ String

#provisioned_bandwidth ⇒ Types::ProvisionedBandwidth

#route_table_id ⇒ String

#state ⇒ String

#subnet_id ⇒ String

#tags ⇒ Array<Types::Tag>

#vpc_id ⇒ String

#attached_appliances ⇒ `Array<Types::NatGatewayAttachedAppliance>`

#auto_provision_zones ⇒ `String`

#auto_scaling_ips ⇒ `String`

#availability_mode ⇒ `String`

#connectivity_type ⇒ `String`

#create_time ⇒ `Time`

#delete_time ⇒ `Time`

#failure_code ⇒ `String`

#failure_message ⇒ `String`

#nat_gateway_addresses ⇒ `Array<Types::NatGatewayAddress>`

#nat_gateway_id ⇒ `String`

#provisioned_bandwidth ⇒ `Types::ProvisionedBandwidth`

#route_table_id ⇒ `String`

#state ⇒ `String`

#subnet_id ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#vpc_id ⇒ `String`