Class NatRule

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

Describes a NAT rule of an attachment.

See Also:

  • Method Details

    • ruleNumber

      public final Integer ruleNumber()

      The rule number. Rule numbers identify the rules of an attachment and don't set the order in which rules are evaluated.

      Returns:
      The rule number. Rule numbers identify the rules of an attachment and don't set the order in which rules are evaluated.

    • matchSourceCidr

      public final String matchSourceCidr()

      The source CIDR block that the rule matches for traffic from the attachment.

      Returns:
      The source CIDR block that the rule matches for traffic from the attachment.

    • natCidr

      public final String natCidr()

      The CIDR block that matching source addresses are translated to.

      Returns:
      The CIDR block that matching source addresses are translated to.

    • state

      public final NatRuleState state()

      The state of the NAT rule. The possible values are the following:

      • CREATING: The rule is being created.

      • MODIFYING: The rule is being modified.

      • DELETING: The rule is being deleted.

      • ACTIVATING: NAT gateway support is being enabled, and the rule is being applied.

      • ACTIVATED: NAT gateway support is enabled, and the rule is applied.

      • DEACTIVATING: NAT gateway support is being disabled, and the rule is being removed from use.

      • DEACTIVATED: NAT gateway support is disabled, and the rule isn't applied.

      • FAILED: The attachment failed to be created, and the rule isn't applied.

      • PENDING_ATTACHMENT_ACCEPTANCE: The attachment is pending acceptance. The rule is applied after the attachment is accepted.

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

      Returns:
      The state of the NAT rule. The possible values are the following:

      • CREATING: The rule is being created.

      • MODIFYING: The rule is being modified.

      • DELETING: The rule is being deleted.

      • ACTIVATING: NAT gateway support is being enabled, and the rule is being applied.

      • ACTIVATED: NAT gateway support is enabled, and the rule is applied.

      • DEACTIVATING: NAT gateway support is being disabled, and the rule is being removed from use.

      • DEACTIVATED: NAT gateway support is disabled, and the rule isn't applied.

      • FAILED: The attachment failed to be created, and the rule isn't applied.

      • PENDING_ATTACHMENT_ACCEPTANCE: The attachment is pending acceptance. The rule is applied after the attachment is accepted.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the NAT rule. The possible values are the following:

      • CREATING: The rule is being created.

      • MODIFYING: The rule is being modified.

      • DELETING: The rule is being deleted.

      • ACTIVATING: NAT gateway support is being enabled, and the rule is being applied.

      • ACTIVATED: NAT gateway support is enabled, and the rule is applied.

      • DEACTIVATING: NAT gateway support is being disabled, and the rule is being removed from use.

      • DEACTIVATED: NAT gateway support is disabled, and the rule isn't applied.

      • FAILED: The attachment failed to be created, and the rule isn't applied.

      • PENDING_ATTACHMENT_ACCEPTANCE: The attachment is pending acceptance. The rule is applied after the attachment is accepted.

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

      Returns:
      The state of the NAT rule. The possible values are the following:

      • CREATING: The rule is being created.

      • MODIFYING: The rule is being modified.

      • DELETING: The rule is being deleted.

      • ACTIVATING: NAT gateway support is being enabled, and the rule is being applied.

      • ACTIVATED: NAT gateway support is enabled, and the rule is applied.

      • DEACTIVATING: NAT gateway support is being disabled, and the rule is being removed from use.

      • DEACTIVATED: NAT gateway support is disabled, and the rule isn't applied.

      • FAILED: The attachment failed to be created, and the rule isn't applied.

      • PENDING_ATTACHMENT_ACCEPTANCE: The attachment is pending acceptance. The rule is applied after the attachment is accepted.

      See Also:

    • toBuilder

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

    • builder

      public static NatRule.Builder builder()

    • serializableBuilderClass

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