Class NatGatewayAddress

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:

  • Method Details

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

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NatGatewayAddress.Builder,NatGatewayAddress>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.