Class NatGateway
- All Implemented Interfaces:
Serializable
,Cloneable
Describes a NAT gateway.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The date and time the NAT gateway was created.The date and time the NAT gateway was deleted, if applicable.If the NAT gateway could not be created, specifies the error code for the failure.If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.Information about the IP addresses and network interface associated with the NAT gateway.The ID of the NAT gateway.getState()
The state of the NAT gateway.The ID of the subnet in which the NAT gateway is located.getVpcId()
The ID of the VPC in which the NAT gateway is located.int
hashCode()
void
setCreateTime
(Date createTime) The date and time the NAT gateway was created.void
setDeleteTime
(Date deleteTime) The date and time the NAT gateway was deleted, if applicable.void
setFailureCode
(String failureCode) If the NAT gateway could not be created, specifies the error code for the failure.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.void
setNatGatewayAddresses
(Collection<NatGatewayAddress> natGatewayAddresses) Information about the IP addresses and network interface associated with the NAT gateway.void
setNatGatewayId
(String natGatewayId) The ID of the NAT gateway.void
setState
(NatGatewayState state) The state of the NAT gateway.void
The state of the NAT gateway.void
setSubnetId
(String subnetId) The ID of the subnet in which the NAT gateway is located.void
The ID of the VPC in which the NAT gateway is located.toString()
Returns a string representation of this object; useful for testing and debugging.withCreateTime
(Date createTime) The date and time the NAT gateway was created.withDeleteTime
(Date deleteTime) The date and time the NAT gateway was deleted, if applicable.withFailureCode
(String failureCode) If the NAT gateway could not be created, specifies the error code for the failure.withFailureMessage
(String failureMessage) If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.withNatGatewayAddresses
(NatGatewayAddress... natGatewayAddresses) Information about the IP addresses and network interface associated with the NAT gateway.withNatGatewayAddresses
(Collection<NatGatewayAddress> natGatewayAddresses) Information about the IP addresses and network interface associated with the NAT gateway.withNatGatewayId
(String natGatewayId) The ID of the NAT gateway.withState
(NatGatewayState state) The state of the NAT gateway.The state of the NAT gateway.withSubnetId
(String subnetId) The ID of the subnet in which the NAT gateway is located.The ID of the VPC in which the NAT gateway is located.
-
Constructor Details
-
NatGateway
public NatGateway()
-
-
Method Details
-
setVpcId
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
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
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
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
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
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
The ID of the NAT gateway.
- Parameters:
natGatewayId
- The ID of the NAT gateway.
-
getNatGatewayId
The ID of the NAT gateway.
- Returns:
- The ID of the NAT gateway.
-
withNatGatewayId
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
The date and time the NAT gateway was created.
- Parameters:
createTime
- The date and time the NAT gateway was created.
-
getCreateTime
The date and time the NAT gateway was created.
- Returns:
- The date and time the NAT gateway was created.
-
withCreateTime
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
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
The date and time the NAT gateway was deleted, if applicable.
- Returns:
- The date and time the NAT gateway was deleted, if applicable.
-
withDeleteTime
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
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
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
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)
orwithNatGatewayAddresses(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
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
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 thefailureCode
andfailureMessage
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 thefailureCode
andfailureMessage
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
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 thefailureCode
andfailureMessage
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 thefailureCode
andfailureMessage
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
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 thefailureCode
andfailureMessage
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 thefailureCode
andfailureMessage
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
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 thefailureCode
andfailureMessage
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 thefailureCode
andfailureMessage
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
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 thefailureCode
andfailureMessage
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 thefailureCode
andfailureMessage
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-