Class AwsEc2SecurityGroupIpPermission

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

An IP permission for an EC2 security group.

See Also:

  • Method Details

    • ipProtocol

      public final String ipProtocol()

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

      [VPC only] Use -1 to specify all protocols.

      When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.

      For tcp, udp, and icmp, you must specify a port range.

      For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.

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

      [VPC only] Use -1 to specify all protocols.

      When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.

      For tcp, udp, and icmp, you must specify a port range.

      For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.

    • fromPort

      public final Integer fromPort()

      The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

      A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

      Returns:
      The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

      A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    • toPort

      public final Integer toPort()

      The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

      A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

      Returns:
      The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

      A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    • hasUserIdGroupPairs

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

    • userIdGroupPairs

      public final List<AwsEc2SecurityGroupUserIdGroupPair> userIdGroupPairs()

      The security group and Amazon Web Services account ID pairs.

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

      Returns:
      The security group and Amazon Web Services account ID pairs.

    • hasIpRanges

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

    • ipRanges

      public final List<AwsEc2SecurityGroupIpRange> ipRanges()

      The IPv4 ranges.

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

      Returns:
      The IPv4 ranges.

    • hasIpv6Ranges

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

    • ipv6Ranges

      public final List<AwsEc2SecurityGroupIpv6Range> ipv6Ranges()

      The IPv6 ranges.

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

      Returns:
      The IPv6 ranges.

    • hasPrefixListIds

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

    • prefixListIds

      public final List<AwsEc2SecurityGroupPrefixListId> prefixListIds()

      [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.

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

      Returns:
      [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.

    • toBuilder

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

    • builder

      public static AwsEc2SecurityGroupIpPermission.Builder builder()

    • serializableBuilderClass

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