IpPermission (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.IpPermission

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IpPermission
extends Object
implements Serializable, Cloneable
```
Describes a set of permissions for a security group rule.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IpPermission()

Constructors
Constructor and Description
`IpPermission()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`IpPermission`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getFromPort()` The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
`String`	`getIpProtocol()` The IP protocol name (`tcp`, `udp`, `icmp`) or number (see Protocol Numbers).
`List<String>`	`getIpRanges()` Deprecated. Use `getIpv4Ranges()`.
`List<IpRange>`	`getIpv4Ranges()` One or more IPv4 ranges.
`List<Ipv6Range>`	`getIpv6Ranges()` [EC2-VPC only] One or more IPv6 ranges.
`List<PrefixListId>`	`getPrefixListIds()` (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service.
`Integer`	`getToPort()` The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`List<UserIdGroupPair>`	`getUserIdGroupPairs()` One or more security group and AWS account ID pairs.
`int`	`hashCode()`
`void`	`setFromPort(Integer fromPort)` The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
`void`	`setIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`) or number (see Protocol Numbers).
`void`	`setIpRanges(Collection<String> ipRanges)` Deprecated. Use `setIpv4Ranges(java.util.Collection)`
`void`	`setIpv4Ranges(Collection<IpRange> ipv4Ranges)` One or more IPv4 ranges.
`void`	`setIpv6Ranges(Collection<Ipv6Range> ipv6Ranges)` [EC2-VPC only] One or more IPv6 ranges.
`void`	`setPrefixListIds(Collection<PrefixListId> prefixListIds)` (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service.
`void`	`setToPort(Integer toPort)` The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`void`	`setUserIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)` One or more security group and AWS account ID pairs.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`IpPermission`	`withFromPort(Integer fromPort)` The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
`IpPermission`	`withIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`) or number (see Protocol Numbers).
`IpPermission`	`withIpRanges(Collection<String> ipRanges)` Deprecated. Use `withIpv4Ranges(java.util.Collection)`
`IpPermission`	`withIpRanges(String... ipRanges)` Deprecated. Use `withIpv4Ranges(IpRange...)`
`IpPermission`	`withIpv4Ranges(Collection<IpRange> ipv4Ranges)` One or more IPv4 ranges.
`IpPermission`	`withIpv4Ranges(IpRange... ipv4Ranges)` One or more IPv4 ranges.
`IpPermission`	`withIpv6Ranges(Collection<Ipv6Range> ipv6Ranges)` [EC2-VPC only] One or more IPv6 ranges.
`IpPermission`	`withIpv6Ranges(Ipv6Range... ipv6Ranges)` [EC2-VPC only] One or more IPv6 ranges.
`IpPermission`	`withPrefixListIds(Collection<PrefixListId> prefixListIds)` (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service.
`IpPermission`	`withPrefixListIds(PrefixListId... prefixListIds)` (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service.
`IpPermission`	`withToPort(Integer toPort)` The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`IpPermission`	`withUserIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)` One or more security group and AWS account ID pairs.
`IpPermission`	`withUserIdGroupPairs(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

- Constructor Detail
  - IpPermission
```
public IpPermission()
```
- Method Detail
  - setFromPort
```
public void setFromPort(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.
    
    Parameters:
    
    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.
  - getFromPort
```
public Integer getFromPort()
```
    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.
  - withFromPort
```
public IpPermission withFromPort(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpProtocol
```
public void setIpProtocol(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.
    
    Parameters:
    
    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.
  - getIpProtocol
```
public String getIpProtocol()
```
    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.
  - withIpProtocol
```
public IpPermission withIpProtocol(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIpv6Ranges
```
public List<Ipv6Range> getIpv6Ranges()
```
    [EC2-VPC only] One or more IPv6 ranges.
    
    Returns:
    
    [EC2-VPC only] One or more IPv6 ranges.
  - setIpv6Ranges
```
public void setIpv6Ranges(Collection<Ipv6Range> ipv6Ranges)
```
    [EC2-VPC only] One or more IPv6 ranges.
    
    Parameters:
    
    ipv6Ranges - [EC2-VPC only] One or more IPv6 ranges.
  - withIpv6Ranges
```
public IpPermission withIpv6Ranges(Ipv6Range... ipv6Ranges)
```
    [EC2-VPC only] One or more IPv6 ranges.
    
    NOTE: This method appends the values to the existing list (if any). Use setIpv6Ranges(java.util.Collection) or withIpv6Ranges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ipv6Ranges - [EC2-VPC only] One or more IPv6 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpv6Ranges
```
public IpPermission withIpv6Ranges(Collection<Ipv6Range> ipv6Ranges)
```
    [EC2-VPC only] One or more IPv6 ranges.
    
    Parameters:
    
    ipv6Ranges - [EC2-VPC only] One or more IPv6 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPrefixListIds
```
public List<PrefixListId> getPrefixListIds()
```
    (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.
  - setPrefixListIds
```
public void setPrefixListIds(Collection<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.
    
    Parameters:
    
    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.
  - withPrefixListIds
```
public IpPermission withPrefixListIds(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setPrefixListIds(java.util.Collection) or withPrefixListIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPrefixListIds
```
public IpPermission withPrefixListIds(Collection<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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setToPort
```
public void setToPort(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. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Parameters:
    
    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. If you specify all ICMP/ICMPv6 types, you must specify all codes.
  - getToPort
```
public Integer getToPort()
```
    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. 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 for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.
  - withToPort
```
public IpPermission withToPort(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. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Parameters:
    
    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. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserIdGroupPairs
```
public List<UserIdGroupPair> getUserIdGroupPairs()
```
    One or more security group and AWS account ID pairs.
    
    Returns:
    
    One or more security group and AWS account ID pairs.
  - setUserIdGroupPairs
```
public void setUserIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)
```
    One or more security group and AWS account ID pairs.
    
    Parameters:
    
    userIdGroupPairs - One or more security group and AWS account ID pairs.
  - withUserIdGroupPairs
```
public IpPermission withUserIdGroupPairs(UserIdGroupPair... userIdGroupPairs)
```
    One or more security group and AWS account ID pairs.
    
    NOTE: This method appends the values to the existing list (if any). Use setUserIdGroupPairs(java.util.Collection) or withUserIdGroupPairs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    userIdGroupPairs - One or more security group and AWS account ID pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserIdGroupPairs
```
public IpPermission withUserIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)
```
    One or more security group and AWS account ID pairs.
    
    Parameters:
    
    userIdGroupPairs - One or more security group and AWS account ID pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIpv4Ranges
```
public List<IpRange> getIpv4Ranges()
```
    One or more IPv4 ranges.
    
    Returns:
    
    One or more IPv4 ranges.
  - setIpv4Ranges
```
public void setIpv4Ranges(Collection<IpRange> ipv4Ranges)
```
    One or more IPv4 ranges.
    
    Parameters:
    
    ipv4Ranges - One or more IPv4 ranges.
  - withIpv4Ranges
```
public IpPermission withIpv4Ranges(IpRange... ipv4Ranges)
```
    One or more IPv4 ranges.
    
    NOTE: This method appends the values to the existing list (if any). Use setIpv4Ranges(java.util.Collection) or withIpv4Ranges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ipv4Ranges - One or more IPv4 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpv4Ranges
```
public IpPermission withIpv4Ranges(Collection<IpRange> ipv4Ranges)
```
    One or more IPv4 ranges.
    
    Parameters:
    
    ipv4Ranges - One or more IPv4 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIpRanges
```
@Deprecated
public List<String> getIpRanges()
```
    Deprecated. Use getIpv4Ranges().
    
    One or more IP ranges.
    
    Returns:
    
    One or more IP ranges.
  - setIpRanges
```
@Deprecated
public void setIpRanges(Collection<String> ipRanges)
```
    Deprecated. Use setIpv4Ranges(java.util.Collection)
    
    One or more IP ranges.
    
    Parameters:
    
    ipRanges - One or more IP ranges.
  - withIpRanges
```
@Deprecated
public IpPermission withIpRanges(String... ipRanges)
```
    Deprecated. Use withIpv4Ranges(IpRange...)
    
    One or more IP ranges.
    
    NOTE: This method appends the values to the existing list (if any). Use setIpRanges(java.util.Collection) or withIpRanges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ipRanges - One or more IP ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpRanges
```
@Deprecated
public IpPermission withIpRanges(Collection<String> ipRanges)
```
    Deprecated. Use withIpv4Ranges(java.util.Collection)
    
    One or more IP ranges.
    
    Parameters:
    
    ipRanges - One or more IP ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public IpPermission clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class IpPermission

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IpPermission

Method Detail

setFromPort

getFromPort

withFromPort

setIpProtocol

getIpProtocol

withIpProtocol

getIpv6Ranges

setIpv6Ranges

withIpv6Ranges

withIpv6Ranges

getPrefixListIds

setPrefixListIds

withPrefixListIds

withPrefixListIds

setToPort

getToPort

withToPort

getUserIdGroupPairs

setUserIdGroupPairs

withUserIdGroupPairs

withUserIdGroupPairs

getIpv4Ranges

setIpv4Ranges

withIpv4Ranges

withIpv4Ranges

getIpRanges

setIpRanges

withIpRanges

withIpRanges

toString

equals

hashCode

clone