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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NatGatewayAddress.Builder,NatGatewayAddress>
```
@Generated("software.amazon.awssdk:codegen")
public final class NatGatewayAddress
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NatGatewayAddress.Builder,NatGatewayAddress>
```
Describes the IP addresses and network interface associated with a NAT gateway.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface NatGatewayAddress.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`allocationId()`	[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
`String`	`associationId()`	[Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway.
`String`	`availabilityZone()`	The Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic.
`String`	`availabilityZoneId()`	The ID of the Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic.
`static NatGatewayAddress.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureMessage()`	The address failure message.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`isPrimary()`	Defines if the IP address is the primary address.
`String`	`networkInterfaceId()`	The ID of the network interface associated with the NAT gateway.
`String`	`privateIp()`	The private IP address associated with the NAT gateway.
`String`	`publicIp()`	[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends NatGatewayAddress.Builder>`	`serializableBuilderClass()`
`NatGatewayAddressStatus`	`status()`	The address status.
`String`	`statusAsString()`	The address status.
`NatGatewayAddress.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - allocationId
```
public final String allocationId()
```
    [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
    
    Returns:
    
    [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
  - networkInterfaceId
```
public final String networkInterfaceId()
```
    The ID of the network interface associated with the NAT gateway.
    
    Returns:
    
    The ID of the network interface associated with the NAT gateway.
  - privateIp
```
public final String privateIp()
```
    The private IP address associated with the NAT gateway.
    
    Returns:
    
    The private IP address associated with the NAT gateway.
  - publicIp
```
public final String publicIp()
```
    [Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
    
    Returns:
    
    [Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
  - associationId
```
public final String associationId()
```
    [Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway.
    
    Returns:
    
    [Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway.
  - isPrimary
```
public final Boolean isPrimary()
```
    Defines if the IP address is the primary address.
    
    Returns:
    
    Defines if the IP address is the primary address.
  - failureMessage
```
public final String failureMessage()
```
    The address failure message.
    
    Returns:
    
    The address failure message.
  - status
```
public final NatGatewayAddressStatus status()
```
    The address status.
    
    If the service returns an enum value that is not available in the current SDK version, status will return NatGatewayAddressStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The address status.
    
    See Also:
    
    NatGatewayAddressStatus
  - statusAsString
```
public final String statusAsString()
```
    The address status.
    
    If the service returns an enum value that is not available in the current SDK version, status will return NatGatewayAddressStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The address status.
    
    See Also:
    
    NatGatewayAddressStatus
  - availabilityZone
```
public final String availabilityZone()
```
    The Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic.
    
    Returns:
    
    The Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic.
  - availabilityZoneId
```
public final String availabilityZoneId()
```
    The ID of the Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic. Use this instead of AvailabilityZone for consistent identification of AZs across Amazon Web Services Regions.
    
    Returns:
    
    The ID of the Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic. Use this instead of AvailabilityZone for consistent identification of AZs across Amazon Web Services Regions.
  - toBuilder
```
public NatGatewayAddress.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<NatGatewayAddress.Builder,NatGatewayAddress>
  - builder
```
public static NatGatewayAddress.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends NatGatewayAddress.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class NatGatewayAddress

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

allocationId

networkInterfaceId

privateIp

publicIp

associationId

isPrimary

failureMessage

status

statusAsString

availabilityZone

availabilityZoneId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField