software.amazon.awssdk.services.ec2.model

Class IpPermission

java.lang.Object

software.amazon.awssdk.services.ec2.model.IpPermission

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IpPermission.Builder,IpPermission>

@Generated(value="software.amazon.awssdk:codegen")
public final class IpPermission
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IpPermission.Builder,IpPermission>

Describes a set of permissions for a security group rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IpPermission.Builder

Method Summary

Modifier and Type	Method and Description
static IpPermission.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	fromPort() If the protocol is TCP or UDP, this is the start of the port range.
<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 (see Protocol Numbers).
List<IpRange>	ipRanges() The IPv4 ranges.
List<Ipv6Range>	ipv6Ranges() The IPv6 ranges.
List<PrefixListId>	prefixListIds() The prefix list IDs.
List<SdkField<?>>	sdkFields()
static Class<? extends IpPermission.Builder>	serializableBuilderClass()
IpPermission.Builder	toBuilder()
Integer	toPort() If the protocol is TCP or UDP, this is the end of the port range.
String	toString() Returns a string representation of this object.
List<UserIdGroupPair>	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

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 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

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 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

ipProtocol

public final String ipProtocol()

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

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 (see Protocol Numbers).

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.

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<IpRange> 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<Ipv6Range> 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<PrefixListId> prefixListIds()

The prefix list IDs.

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:

The prefix list IDs.

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 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 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 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 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<UserIdGroupPair> 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.

toBuilder

public IpPermission.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IpPermission.Builder,IpPermission>

builder

public static IpPermission.Builder builder()

serializableBuilderClass

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