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() The start of 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() Returns true if the IpRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasIpv6Ranges() Returns true if the Ipv6Ranges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasPrefixListIds() Returns true if the PrefixListIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasUserIdGroupPairs() Returns true if the UserIdGroupPairs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	ipProtocol() The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
List<IpRange>	ipRanges() The IPv4 ranges.
List<Ipv6Range>	ipv6Ranges() [VPC only] The IPv6 ranges.
List<PrefixListId>	prefixListIds() [VPC only] The prefix list IDs.
List<SdkField<?>>	sdkFields()
static Class<? extends IpPermission.Builder>	serializableBuilderClass()
IpPermission.Builder	toBuilder()
Integer	toPort() The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
String	toString() Returns a string representation of this object.
List<UserIdGroupPair>	userIdGroupPairs() The security group and AWS 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 Integer fromPort()

The start of 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 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.

ipProtocol

public String ipProtocol()

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

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

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

hasIpRanges

public boolean hasIpRanges()

Returns true if the IpRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

ipRanges

public List<IpRange> ipRanges()

The IPv4 ranges.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIpRanges() to see if a value was sent in this field.

Returns:

The IPv4 ranges.

hasIpv6Ranges

public boolean hasIpv6Ranges()

Returns true if the Ipv6Ranges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

ipv6Ranges

public List<Ipv6Range> ipv6Ranges()

[VPC only] The IPv6 ranges.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIpv6Ranges() to see if a value was sent in this field.

Returns:

[VPC only] The IPv6 ranges.

hasPrefixListIds

public boolean hasPrefixListIds()

Returns true if the PrefixListIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

prefixListIds

public List<PrefixListId> prefixListIds()

[VPC only] The prefix list IDs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPrefixListIds() to see if a value was sent in this field.

Returns:

[VPC only] The prefix list IDs.

toPort

public Integer toPort()

The end of 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 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 boolean hasUserIdGroupPairs()

Returns true if the UserIdGroupPairs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

userIdGroupPairs

public List<UserIdGroupPair> userIdGroupPairs()

The security group and AWS account ID pairs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasUserIdGroupPairs() to see if a value was sent in this field.

Returns:

The security group and AWS 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo