Class SecurityGroupRule

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

Describes a security group rule.

See Also:

  • Method Details

    • securityGroupRuleId

      public final String securityGroupRuleId()

      The ID of the security group rule.

      Returns:
      The ID of the security group rule.

    • groupId

      public final String groupId()

      The ID of the security group.

      Returns:
      The ID of the security group.

    • groupOwnerId

      public final String groupOwnerId()

      The ID of the Amazon Web Services account that owns the security group.

      Returns:
      The ID of the Amazon Web Services account that owns the security group.

    • isEgress

      public final Boolean isEgress()

      Indicates whether the security group rule is an outbound rule.

      Returns:
      Indicates whether the security group rule is an outbound rule.

    • ipProtocol

      public final String ipProtocol()

      The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

      Use -1 to specify all protocols.

      Returns:
      The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

      Use -1 to specify all protocols.

    • fromPort

      public final Integer fromPort()

      If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

      Returns:
      If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

    • toPort

      public final Integer toPort()

      If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

      Returns:
      If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

    • cidrIpv4

      public final String cidrIpv4()

      The IPv4 CIDR range.

      Returns:
      The IPv4 CIDR range.

    • cidrIpv6

      public final String cidrIpv6()

      The IPv6 CIDR range.

      Returns:
      The IPv6 CIDR range.

    • prefixListId

      public final String prefixListId()

      The ID of the prefix list.

      Returns:
      The ID of the prefix list.

    • referencedGroupInfo

      public final ReferencedSecurityGroup referencedGroupInfo()

      Describes the security group that is referenced in the rule.

      Returns:
      Describes the security group that is referenced in the rule.

    • description

      public final String description()

      The security group rule description.

      Returns:
      The security group rule description.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The tags applied to the security group rule.

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

      Returns:
      The tags applied to the security group rule.

    • toBuilder

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

    • builder

      public static SecurityGroupRule.Builder builder()

    • serializableBuilderClass

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