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()` If the protocol is TCP or UDP, this is the start of the port range.
`String`	`getIpProtocol()` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number (see Protocol Numbers).
`List<String>`	`getIpRanges()` Deprecated. Use `getIpv4Ranges()`.
`List<IpRange>`	`getIpv4Ranges()` The IPv4 ranges.
`List<Ipv6Range>`	`getIpv6Ranges()` [VPC only] The IPv6 ranges.
`List<PrefixListId>`	`getPrefixListIds()` [VPC only] The prefix list IDs.
`Integer`	`getToPort()` If the protocol is TCP or UDP, this is the end of the port range.
`List<UserIdGroupPair>`	`getUserIdGroupPairs()` The security group and Amazon Web Services account ID pairs.
`int`	`hashCode()`
`void`	`setFromPort(Integer fromPort)` If the protocol is TCP or UDP, this is the start of the port range.
`void`	`setIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number (see Protocol Numbers).
`void`	`setIpRanges(Collection<String> ipRanges)` Deprecated. Use `setIpv4Ranges(java.util.Collection)`
`void`	`setIpv4Ranges(Collection<IpRange> ipv4Ranges)` The IPv4 ranges.
`void`	`setIpv6Ranges(Collection<Ipv6Range> ipv6Ranges)` [VPC only] The IPv6 ranges.
`void`	`setPrefixListIds(Collection<PrefixListId> prefixListIds)` [VPC only] The prefix list IDs.
`void`	`setToPort(Integer toPort)` If the protocol is TCP or UDP, this is the end of the port range.
`void`	`setUserIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)` The security group and Amazon Web Services account ID pairs.
`String`	`toString()` Returns a string representation of this object.
`IpPermission`	`withFromPort(Integer fromPort)` If the protocol is TCP or UDP, this is the start of the port range.
`IpPermission`	`withIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) 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)` The IPv4 ranges.
`IpPermission`	`withIpv4Ranges(IpRange... ipv4Ranges)` The IPv4 ranges.
`IpPermission`	`withIpv6Ranges(Collection<Ipv6Range> ipv6Ranges)` [VPC only] The IPv6 ranges.
`IpPermission`	`withIpv6Ranges(Ipv6Range... ipv6Ranges)` [VPC only] The IPv6 ranges.
`IpPermission`	`withPrefixListIds(Collection<PrefixListId> prefixListIds)` [VPC only] The prefix list IDs.
`IpPermission`	`withPrefixListIds(PrefixListId... prefixListIds)` [VPC only] The prefix list IDs.
`IpPermission`	`withToPort(Integer toPort)` If the protocol is TCP or UDP, this is the end of the port range.
`IpPermission`	`withUserIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)` The security group and Amazon Web Services account ID pairs.
`IpPermission`	`withUserIdGroupPairs(UserIdGroupPair... userIdGroupPairs)` The security group and Amazon Web Services 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)
```
    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.
    
    Parameters:
    
    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.
  - getFromPort
```
public Integer getFromPort()
```
    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.
  - withFromPort
```
public IpPermission withFromPort(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.
    
    Parameters:
    
    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:
    
    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, 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.
    
    Parameters:
    
    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.
  - getIpProtocol
```
public String getIpProtocol()
```
    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.
  - withIpProtocol
```
public IpPermission withIpProtocol(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIpv6Ranges
```
public List<Ipv6Range> getIpv6Ranges()
```
    [VPC only] The IPv6 ranges.
    
    Returns:
    
    [VPC only] The IPv6 ranges.
  - setIpv6Ranges
```
public void setIpv6Ranges(Collection<Ipv6Range> ipv6Ranges)
```
    [VPC only] The IPv6 ranges.
    
    Parameters:
    
    ipv6Ranges - [VPC only] The IPv6 ranges.
  - withIpv6Ranges
```
public IpPermission withIpv6Ranges(Ipv6Range... ipv6Ranges)
```
    [VPC only] The 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 - [VPC only] The IPv6 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpv6Ranges
```
public IpPermission withIpv6Ranges(Collection<Ipv6Range> ipv6Ranges)
```
    [VPC only] The IPv6 ranges.
    
    Parameters:
    
    ipv6Ranges - [VPC only] The IPv6 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPrefixListIds
```
public List<PrefixListId> getPrefixListIds()
```
    [VPC only] The prefix list IDs.
    
    Returns:
    
    [VPC only] The prefix list IDs.
  - setPrefixListIds
```
public void setPrefixListIds(Collection<PrefixListId> prefixListIds)
```
    [VPC only] The prefix list IDs.
    
    Parameters:
    
    prefixListIds - [VPC only] The prefix list IDs.
  - withPrefixListIds
```
public IpPermission withPrefixListIds(PrefixListId... prefixListIds)
```
    [VPC only] The prefix list IDs.
    
    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 - [VPC only] The prefix list IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPrefixListIds
```
public IpPermission withPrefixListIds(Collection<PrefixListId> prefixListIds)
```
    [VPC only] The prefix list IDs.
    
    Parameters:
    
    prefixListIds - [VPC only] The prefix list IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setToPort
```
public void setToPort(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.
    
    Parameters:
    
    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.
  - getToPort
```
public Integer getToPort()
```
    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.
  - withToPort
```
public IpPermission withToPort(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserIdGroupPairs
```
public List<UserIdGroupPair> getUserIdGroupPairs()
```
    The security group and Amazon Web Services account ID pairs.
    
    Returns:
    
    The security group and Amazon Web Services account ID pairs.
  - setUserIdGroupPairs
```
public void setUserIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)
```
    The security group and Amazon Web Services account ID pairs.
    
    Parameters:
    
    userIdGroupPairs - The security group and Amazon Web Services account ID pairs.
  - withUserIdGroupPairs
```
public IpPermission withUserIdGroupPairs(UserIdGroupPair... userIdGroupPairs)
```
    The security group and Amazon Web Services 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 - The security group and Amazon Web Services 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)
```
    The security group and Amazon Web Services account ID pairs.
    
    Parameters:
    
    userIdGroupPairs - The security group and Amazon Web Services account ID pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIpv4Ranges
```
public List<IpRange> getIpv4Ranges()
```
    The IPv4 ranges.
    
    Returns:
    
    The IPv4 ranges.
  - setIpv4Ranges
```
public void setIpv4Ranges(Collection<IpRange> ipv4Ranges)
```
    The IPv4 ranges.
    
    Parameters:
    
    ipv4Ranges - The IPv4 ranges.
  - withIpv4Ranges
```
public IpPermission withIpv4Ranges(IpRange... ipv4Ranges)
```
    The 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 - The IPv4 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpv4Ranges
```
public IpPermission withIpv4Ranges(Collection<IpRange> ipv4Ranges)
```
    The IPv4 ranges.
    
    Parameters:
    
    ipv4Ranges - The 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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