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)
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()
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 for an AWS service.
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.

ipRanges

public List<IpRange> ipRanges()

The IPv4 ranges.

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

Returns:

The IPv4 ranges.

ipv6Ranges

public List<Ipv6Range> ipv6Ranges()

[VPC only] The IPv6 ranges.

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

Returns:

[VPC only] The IPv6 ranges.

prefixListIds

public List<PrefixListId> prefixListIds()

[VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS 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.

Returns:

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

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.

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.

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

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