Package software.amazon.awssdk.services.ec2.model

Class IpPermission

java.lang.Object

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

All Implemented Interfaces:

ToCopyableBuilder<IpPermission.Builder,IpPermission>

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

Describes a security group rule.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IpPermission.Builder

Method Summary

Modifier and Type	Method	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.
int	hashCode()
String	ipProtocol()	The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
List<IpRange>	ipv4Ranges()	One or more IPv4 ranges.
List<Ipv6Range>	ipv6Ranges()	[EC2-VPC only] One or more IPv6 ranges.
List<PrefixListId>	prefixListIds()	(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service.
static Class<? extends IpPermission.Builder>	serializableBuilderClass()
IpPermission.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Integer	toPort()	The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
String	toString()
List<UserIdGroupPair>	userIdGroupPairs()	One or more security group and AWS account ID pairs.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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.

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.

ipProtocol

public String ipProtocol()

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

[EC2-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 58 (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 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed when authorizing rules.

Returns:

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

[EC2-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 58 (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 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed when authorizing rules.

ipv6Ranges

public List<Ipv6Range> ipv6Ranges()

[EC2-VPC only] One or more IPv6 ranges.

Returns:

[EC2-VPC only] One or more IPv6 ranges.

prefixListIds

public List<PrefixListId> prefixListIds()

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

Returns:

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want 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 for the specified ICMP type.

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 for the specified ICMP type.

userIdGroupPairs

public List<UserIdGroupPair> userIdGroupPairs()

One or more security group and AWS account ID pairs.

Returns:

One or more security group and AWS account ID pairs.

ipv4Ranges

public List<IpRange> ipv4Ranges()

One or more IPv4 ranges.

Returns:

One or more IPv4 ranges.

toBuilder

public IpPermission.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<IpPermission.Builder,IpPermission>

Returns:

a builder for type T

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()

Overrides:

toString in class Object