Class NatGateway

java.lang.Object
com.amazonaws.services.ec2.model.NatGateway
All Implemented Interfaces:
Serializable, Cloneable

public class NatGateway extends Object implements Serializable, Cloneable

Describes a NAT gateway.

See Also:
  • Constructor Details

    • NatGateway

      public NatGateway()
  • Method Details

    • setVpcId

      public void setVpcId(String vpcId)

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

      Parameters:
      vpcId - The ID of the VPC in which the NAT gateway is located.
    • getVpcId

      public String getVpcId()

      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.
    • withVpcId

      public NatGateway withVpcId(String vpcId)

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

      Parameters:
      vpcId - The ID of the VPC in which the NAT gateway is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSubnetId

      public void setSubnetId(String subnetId)

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

      Parameters:
      subnetId - The ID of the subnet in which the NAT gateway is located.
    • getSubnetId

      public String getSubnetId()

      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.
    • withSubnetId

      public NatGateway withSubnetId(String subnetId)

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

      Parameters:
      subnetId - The ID of the subnet in which the NAT gateway is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setNatGatewayId

      public void setNatGatewayId(String natGatewayId)

      The ID of the NAT gateway.

      Parameters:
      natGatewayId - The ID of the NAT gateway.
    • getNatGatewayId

      public String getNatGatewayId()

      The ID of the NAT gateway.

      Returns:
      The ID of the NAT gateway.
    • withNatGatewayId

      public NatGateway withNatGatewayId(String natGatewayId)

      The ID of the NAT gateway.

      Parameters:
      natGatewayId - The ID of the NAT gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCreateTime

      public void setCreateTime(Date createTime)

      The date and time the NAT gateway was created.

      Parameters:
      createTime - The date and time the NAT gateway was created.
    • getCreateTime

      public Date getCreateTime()

      The date and time the NAT gateway was created.

      Returns:
      The date and time the NAT gateway was created.
    • withCreateTime

      public NatGateway withCreateTime(Date createTime)

      The date and time the NAT gateway was created.

      Parameters:
      createTime - The date and time the NAT gateway was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDeleteTime

      public void setDeleteTime(Date deleteTime)

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

      Parameters:
      deleteTime - The date and time the NAT gateway was deleted, if applicable.
    • getDeleteTime

      public Date getDeleteTime()

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

      Returns:
      The date and time the NAT gateway was deleted, if applicable.
    • withDeleteTime

      public NatGateway withDeleteTime(Date deleteTime)

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

      Parameters:
      deleteTime - The date and time the NAT gateway was deleted, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getNatGatewayAddresses

      public List<NatGatewayAddress> getNatGatewayAddresses()

      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.
    • setNatGatewayAddresses

      public void setNatGatewayAddresses(Collection<NatGatewayAddress> natGatewayAddresses)

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

      Parameters:
      natGatewayAddresses - Information about the IP addresses and network interface associated with the NAT gateway.
    • withNatGatewayAddresses

      public NatGateway withNatGatewayAddresses(NatGatewayAddress... natGatewayAddresses)

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

      NOTE: This method appends the values to the existing list (if any). Use setNatGatewayAddresses(java.util.Collection) or withNatGatewayAddresses(java.util.Collection) if you want to override the existing values.

      Parameters:
      natGatewayAddresses - Information about the IP addresses and network interface associated with the NAT gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withNatGatewayAddresses

      public NatGateway withNatGatewayAddresses(Collection<NatGatewayAddress> natGatewayAddresses)

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

      Parameters:
      natGatewayAddresses - Information about the IP addresses and network interface associated with the NAT gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setState

      public void setState(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.

      Parameters:
      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.

      See Also:
    • getState

      public String getState()

      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:
    • withState

      public NatGateway withState(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setState

      public void setState(NatGatewayState 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.

      Parameters:
      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.

      See Also:
    • withState

      public NatGateway withState(NatGatewayState 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setFailureCode

      public void setFailureCode(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)

      Parameters:
      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 )
    • getFailureCode

      public String getFailureCode()

      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)
    • withFailureCode

      public NatGateway withFailureCode(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)

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setFailureMessage

      public void setFailureMessage(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."

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

    • getFailureMessage

      public String getFailureMessage()

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

    • withFailureMessage

      public NatGateway withFailureMessage(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."

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public NatGateway clone()
      Overrides:
      clone in class Object