Class NatGateway
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.NatGateway
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<NatGateway.Builder,NatGateway>
@Generated("software.amazon.awssdk:codegen") public final class NatGateway extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NatGateway.Builder,NatGateway>
Describes a NAT gateway.
- See Also:
- Serialized Form
-
-
Nested Class Summary
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()
ConnectivityType
connectivityType()
Indicates whether the NAT gateway supports public or private connectivity.String
connectivityTypeAsString()
Indicates whether the NAT gateway supports public or private connectivity.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)
boolean
equalsBySdkFields(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()
boolean
hasNatGatewayAddresses()
For responses, this returns true if the service returned a value for the NatGatewayAddresses property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.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.List<SdkField<?>>
sdkFields()
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()
String
toString()
Returns a string representation of this object.String
vpcId()
The ID of the VPC in which the NAT gateway is located.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
createTime
public final Instant createTime()
The date and time the NAT gateway was created.
- Returns:
- The date and time the NAT gateway was created.
-
deleteTime
public final Instant 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 final 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 final 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."
-
-
-
hasNatGatewayAddresses
public final boolean hasNatGatewayAddresses()
For responses, this returns true if the service returned a value for the NatGatewayAddresses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
natGatewayAddresses
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasNatGatewayAddresses()
method.- Returns:
- Information about the IP addresses and network interface associated with the NAT gateway.
-
natGatewayId
public final String natGatewayId()
The ID of the NAT gateway.
- Returns:
- The ID of the NAT gateway.
-
provisionedBandwidth
public final 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 final 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 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.
If the service returns an enum value that is not available in the current SDK version,
state
will returnNatGatewayState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
NatGatewayState
-
-
stateAsString
public final 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 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.
If the service returns an enum value that is not available in the current SDK version,
state
will returnNatGatewayState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
NatGatewayState
-
-
subnetId
public final 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 final 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.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> tags()
The tags for the NAT gateway.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The tags for the NAT gateway.
-
connectivityType
public final ConnectivityType connectivityType()
Indicates whether the NAT gateway supports public or private connectivity.
If the service returns an enum value that is not available in the current SDK version,
connectivityType
will returnConnectivityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectivityTypeAsString()
.- Returns:
- Indicates whether the NAT gateway supports public or private connectivity.
- See Also:
ConnectivityType
-
connectivityTypeAsString
public final String connectivityTypeAsString()
Indicates whether the NAT gateway supports public or private connectivity.
If the service returns an enum value that is not available in the current SDK version,
connectivityType
will returnConnectivityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectivityTypeAsString()
.- Returns:
- Indicates whether the NAT gateway supports public or private connectivity.
- See Also:
ConnectivityType
-
toBuilder
public NatGateway.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<NatGateway.Builder,NatGateway>
-
builder
public static NatGateway.Builder builder()
-
serializableBuilderClass
public static Class<? extends NatGateway.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-