Class NatGatewayCreateMapping

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

A NAT gateway that Network Firewall creates for a proxy mode firewall in one Availability Zone. You use this in CreateFirewall and AssociateSubnets.

To create a public NAT gateway, specify AllocationIds, and one PrivateIps address for each Elastic IP address. To create a private NAT gateway, specify only PrivateIps. You must specify at least one of them. Each Elastic IP address and private IP address can appear only once in a request.

The NAT gateway is a resource in your account. To change its IP addresses, use Amazon EC2 NAT gateway actions.

See Also:

  • Method Details

    • subnetId

      public final String subnetId()

      The ID of the subnet where Network Firewall creates the NAT gateway. The subnet must be in the firewall's VPC and can't be one of the firewall endpoint subnets. Each mapping must be in a different Availability Zone.

      Returns:
      The ID of the subnet where Network Firewall creates the NAT gateway. The subnet must be in the firewall's VPC and can't be one of the firewall endpoint subnets. Each mapping must be in a different Availability Zone.

    • hasAllocationIds

      public final boolean hasAllocationIds()
      For responses, this returns true if the service returned a value for the AllocationIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • allocationIds

      public final List<String> allocationIds()

      The allocation IDs of the Elastic IP addresses for a public NAT gateway, from 1 to 8. For each allocation ID, specify one address in PrivateIps. If you don't specify this, Network Firewall creates a private 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 hasAllocationIds() method.

      Returns:
      The allocation IDs of the Elastic IP addresses for a public NAT gateway, from 1 to 8. For each allocation ID, specify one address in PrivateIps. If you don't specify this, Network Firewall creates a private NAT gateway.

    • hasPrivateIps

      public final boolean hasPrivateIps()
      For responses, this returns true if the service returned a value for the PrivateIps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • privateIps

      public final List<String> privateIps()

      The private IPv4 addresses of the NAT gateway. The addresses must be in the subnet that you specify and can't be the subnet's reserved addresses.

      For a public NAT gateway, you must specify exactly one address for each Elastic IP address in AllocationIds, even if you specify only one. For a private NAT gateway, specify from 1 to 8 addresses. The first address is the primary address.

      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 hasPrivateIps() method.

      Returns:
      The private IPv4 addresses of the NAT gateway. The addresses must be in the subnet that you specify and can't be the subnet's reserved addresses.

      For a public NAT gateway, you must specify exactly one address for each Elastic IP address in AllocationIds, even if you specify only one. For a private NAT gateway, specify from 1 to 8 addresses. The first address is the primary address.

    • toBuilder

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

    • builder

      public static NatGatewayCreateMapping.Builder builder()

    • serializableBuilderClass

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