AwsEc2SecurityGroupIpPermission (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.securityhub.model.AwsEc2SecurityGroupIpPermission

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AwsEc2SecurityGroupIpPermission.Builder,AwsEc2SecurityGroupIpPermission>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AwsEc2SecurityGroupIpPermission.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AwsEc2SecurityGroupIpPermission.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AwsEc2SecurityGroupIpPermission.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`fromPort()` The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasIpRanges()` For responses, this returns true if the service returned a value for the IpRanges property.
`boolean`	`hasIpv6Ranges()` For responses, this returns true if the service returned a value for the Ipv6Ranges property.
`boolean`	`hasPrefixListIds()` For responses, this returns true if the service returned a value for the PrefixListIds property.
`boolean`	`hasUserIdGroupPairs()` For responses, this returns true if the service returned a value for the UserIdGroupPairs property.
`String`	`ipProtocol()` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number.
`List<AwsEc2SecurityGroupIpRange>`	`ipRanges()` The IPv4 ranges.
`List<AwsEc2SecurityGroupIpv6Range>`	`ipv6Ranges()` The IPv6 ranges.
`List<AwsEc2SecurityGroupPrefixListId>`	`prefixListIds()` [VPC only] The prefix list IDs for an Amazon Web Services service.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AwsEc2SecurityGroupIpPermission.Builder>`	`serializableBuilderClass()`
`AwsEc2SecurityGroupIpPermission.Builder`	`toBuilder()`
`Integer`	`toPort()` The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`String`	`toString()` Returns a string representation of this object.
`List<AwsEc2SecurityGroupUserIdGroupPair>`	`userIdGroupPairs()` The security group and Amazon Web Services account ID pairs.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AwsEc2SecurityGroupIpPermission.Builder,AwsEc2SecurityGroupIpPermission>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class AwsEc2SecurityGroupIpPermission

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ipProtocol

fromPort

toPort

hasUserIdGroupPairs

userIdGroupPairs

hasIpRanges

ipRanges

hasIpv6Ranges

ipv6Ranges

hasPrefixListIds

prefixListIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields