Class CreateNetworkAclEntryRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.CreateNetworkAclEntryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateNetworkAclEntryRequest.Builder,CreateNetworkAclEntryRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateNetworkAclEntryRequest extends Ec2Request implements ToCopyableBuilder<CreateNetworkAclEntryRequest.Builder,CreateNetworkAclEntryRequest>

  • Method Details

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • networkAclId

      public final String networkAclId()

      The ID of the network ACL.

      Returns:
      The ID of the network ACL.

    • ruleNumber

      public final Integer ruleNumber()

      The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

      Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

      Returns:
      The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

      Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

    • protocol

      public final String protocol()

      The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

      Returns:
      The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

    • ruleAction

      public final RuleAction ruleAction()

      Indicates whether to allow or deny the traffic that matches the rule.

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

      Returns:
      Indicates whether to allow or deny the traffic that matches the rule.
      See Also:

    • ruleActionAsString

      public final String ruleActionAsString()

      Indicates whether to allow or deny the traffic that matches the rule.

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

      Returns:
      Indicates whether to allow or deny the traffic that matches the rule.
      See Also:

    • egress

      public final Boolean egress()

      Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

      Returns:
      Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

    • cidrBlock

      public final String cidrBlock()

      The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

      Returns:
      The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

    • ipv6CidrBlock

      public final String ipv6CidrBlock()

      The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).

      Returns:
      The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).

    • icmpTypeCode

      public final IcmpTypeCode icmpTypeCode()

      ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

      Returns:
      ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

    • portRange

      public final PortRange portRange()

      TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

      Returns:
      TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

    • toBuilder

      public CreateNetworkAclEntryRequest.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<CreateNetworkAclEntryRequest.Builder,CreateNetworkAclEntryRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static CreateNetworkAclEntryRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateNetworkAclEntryRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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