Class NatGatewayAttachment

java.lang.Object
software.amazon.awssdk.services.networkfirewall.model.NatGatewayAttachment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NatGatewayAttachment.Builder,NatGatewayAttachment>
@Generated("software.amazon.awssdk:codegen") public final class NatGatewayAttachment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NatGatewayAttachment.Builder,NatGatewayAttachment>

The definition and status of the attachment between a proxy mode firewall and a NAT gateway that proxies its traffic.

See Also:

  • Method Details

    • natGatewayId

      public final String natGatewayId()

      A unique identifier for the NAT gateway to use with proxy resources.

      Returns:
      A unique identifier for the NAT gateway to use with proxy resources.

    • status

      public final NatGatewayAttachmentStatus status()

      The current status of the NAT gateway attachment.

      When this value is READY, the attachment is available to proxy traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.

      If the service returns an enum value that is not available in the current SDK version, status will return NatGatewayAttachmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the NAT gateway attachment.

      When this value is READY, the attachment is available to proxy traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the NAT gateway attachment.

      When this value is READY, the attachment is available to proxy traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.

      If the service returns an enum value that is not available in the current SDK version, status will return NatGatewayAttachmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the NAT gateway attachment.

      When this value is READY, the attachment is available to proxy traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.

      See Also:

    • statusMessage

      public final String statusMessage()

      If Network Firewall encounters an issue with the NAT gateway attachment, it populates this with an explanation of the problem.

      Returns:
      If Network Firewall encounters an issue with the NAT gateway attachment, it populates this with an explanation of the problem.

    • dnsName

      public final String dnsName()

      The DNS name that resolves to the firewall's proxy for traffic sent through this NAT gateway attachment.

      Returns:
      The DNS name that resolves to the firewall's proxy for traffic sent through this NAT gateway attachment.

    • toBuilder

      public NatGatewayAttachment.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<NatGatewayAttachment.Builder,NatGatewayAttachment>
      Returns:
      a builder for type T

    • builder

      public static NatGatewayAttachment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NatGatewayAttachment.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.