NatGateway (AWS SDK for Java - 2.0.0-preview-1)

java.lang.Object
- software.amazon.awssdk.services.ec2.model.NatGateway

All Implemented Interfaces:: ToCopyableBuilder<NatGateway.Builder,NatGateway>

@Generated("software.amazon.awssdk:codegen")
public class NatGateway
extends Object
implements ToCopyableBuilder<NatGateway.Builder,NatGateway>

Describes a NAT gateway.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface NatGateway.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`NatGateway.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static NatGateway.Builder`	`builder()`
`Date`	`createTime()`	The date and time the NAT gateway was created.
`Date`	`deleteTime()`	The date and time the NAT gateway was deleted, if applicable.
`boolean`	`equals(Object obj)`
`String`	`failureCode()`	If the NAT gateway could not be created, specifies the error code for the failure.
`String`	`failureMessage()`	If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
`int`	`hashCode()`
`List<NatGatewayAddress>`	`natGatewayAddresses()`	Information about the IP addresses and network interface associated with the NAT gateway.
`String`	`natGatewayId()`	The ID of the NAT gateway.
`ProvisionedBandwidth`	`provisionedBandwidth()`	Reserved.
`static Class<? extends NatGateway.Builder>`	`serializableBuilderClass()`
`String`	`state()`	The state of the NAT gateway.
`String`	`subnetId()`	The ID of the subnet in which the NAT gateway is located.
`NatGateway.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`vpcId()`	The ID of the VPC in which the NAT gateway is located.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - createTime
```
public Date createTime()
```
    The date and time the NAT gateway was created.
    
    Returns:
    
    The date and time the NAT gateway was created.
  - deleteTime
```
public Date deleteTime()
```
    The date and time the NAT gateway was deleted, if applicable.
    
    Returns:
    
    The date and time the NAT gateway was deleted, if applicable.
  - failureCode
```
public String failureCode()
```
    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)
    
    Returns:
    
    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)
  - failureMessage
```
public String failureMessage()
```
    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:
    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."
  - natGatewayAddresses
```
public List<NatGatewayAddress> natGatewayAddresses()
```
    Information about the IP addresses and network interface associated with the NAT gateway.
    
    Returns:
    
    Information about the IP addresses and network interface associated with the NAT gateway.
  - natGatewayId
```
public String natGatewayId()
```
    The ID of the NAT gateway.
    
    Returns:
    
    The ID of the NAT gateway.
  - provisionedBandwidth
```
public ProvisionedBandwidth provisionedBandwidth()
```
    Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
    
    Returns:
    
    Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
  - state
```
public String state()
```
    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:
    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.
    See Also:
    
    NatGatewayState
  - subnetId
```
public String subnetId()
```
    The ID of the subnet in which the NAT gateway is located.
    
    Returns:
    
    The ID of the subnet in which the NAT gateway is located.
  - vpcId
```
public String vpcId()
```
    The ID of the VPC in which the NAT gateway is located.
    
    Returns:
    
    The ID of the VPC in which the NAT gateway is located.
  - toBuilder
```
public NatGateway.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<NatGateway.Builder,NatGateway>
    
    Returns:
    
    a builder for type T
  - builder
```
public static NatGateway.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends NatGateway.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class NatGateway

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createTime

deleteTime

failureCode

failureMessage

natGatewayAddresses

natGatewayId

provisionedBandwidth

state

subnetId

vpcId

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString