@Generated(value="software.amazon.awssdk:codegen") public final class NatGateway extends Object implements ToCopyableBuilder<NatGateway.Builder,NatGateway>
Describes a NAT gateway.
Modifier and Type | Class and Description |
---|---|
static interface |
NatGateway.Builder |
Modifier and Type | Method and Description |
---|---|
static NatGateway.Builder |
builder() |
Instant |
createTime()
The date and time the NAT gateway was created.
|
Instant |
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.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
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() |
NatGatewayState |
state()
The state of the NAT gateway.
|
String |
stateAsString()
The state of the NAT gateway.
|
String |
subnetId()
The ID of the subnet in which the NAT gateway is located.
|
List<Tag> |
tags()
The tags for the NAT gateway.
|
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.
|
copy
public Instant createTime()
The date and time the NAT gateway was created.
public Instant deleteTime()
The date and time the NAT gateway was deleted, if applicable.
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
)
InsufficientFreeAddressesInSubnet
| Gateway.NotAttached
|
InvalidAllocationID.NotFound
| Resource.AlreadyAssociated
|
InternalError
| InvalidSubnetID.NotFound
)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."
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."
public List<NatGatewayAddress> natGatewayAddresses()
Information about the IP addresses and network interface associated with the NAT gateway.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String natGatewayId()
The ID of the NAT gateway.
public ProvisionedBandwidth provisionedBandwidth()
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
public 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.
If the service returns an enum value that is not available in the current SDK version, state
will return
NatGatewayState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateAsString()
.
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.
NatGatewayState
public String stateAsString()
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.
If the service returns an enum value that is not available in the current SDK version, state
will return
NatGatewayState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateAsString()
.
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.
NatGatewayState
public String subnetId()
The ID of the subnet in which the NAT gateway is located.
public String vpcId()
The ID of the VPC in which the NAT gateway is located.
public List<Tag> tags()
The tags for the NAT gateway.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public NatGateway.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<NatGateway.Builder,NatGateway>
public static NatGateway.Builder builder()
public static Class<? extends NatGateway.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.