com.amazonaws.services.ec2.model

Class IpPermission

java.lang.Object

com.amazonaws.services.ec2.model.IpPermission

All Implemented Interfaces:

Serializable, Cloneable

public class IpPermission
extends Object
implements Serializable, Cloneable

Describes a security group rule.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IpPermission()

Method Summary

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 type number.
String	getIpProtocol() The protocol.
List<String>	getIpRanges() One or more IP 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 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 type number.
void	setIpProtocol(String ipProtocol) The protocol.
void	setIpRanges(Collection<String> ipRanges) One or more IP 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 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 type number.
IpPermission	withIpProtocol(String ipProtocol) The protocol.
IpPermission	withIpRanges(Collection<String> ipRanges) One or more IP ranges.
IpPermission	withIpRanges(String... ipRanges) One or more IP 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 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IpPermission

public IpPermission()

Method Detail

getIpProtocol

public String getIpProtocol()

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

Returns:

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

setIpProtocol

public void setIpProtocol(String ipProtocol)

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

Parameters:

ipProtocol - The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

withIpProtocol

public IpPermission withIpProtocol(String ipProtocol)

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

Returns a reference to this object so that method calls can be chained together.

Parameters:

ipProtocol - The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

Returns:

A reference to this updated object so that method calls can be chained together.

getFromPort

public Integer getFromPort()

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

Returns:

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

setFromPort

public void setFromPort(Integer fromPort)

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

Parameters:

fromPort - The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

withFromPort

public IpPermission withFromPort(Integer fromPort)

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

Returns a reference to this object so that method calls can be chained together.

Parameters:

fromPort - The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

Returns:

A reference to this updated object so that method calls can be chained together.

getToPort

public Integer getToPort()

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

Returns:

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

setToPort

public void setToPort(Integer toPort)

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

Parameters:

toPort - The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

withToPort

public IpPermission withToPort(Integer toPort)

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

Returns a reference to this object so that method calls can be chained together.

Parameters:

toPort - The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

Returns:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

userIdGroupPairs - One or more security group and AWS account ID pairs.

Returns:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

userIdGroupPairs - One or more security group and AWS account ID pairs.

Returns:

A reference to this updated object so that method calls can be chained together.

getIpRanges

public List<String> getIpRanges()

One or more IP ranges.

Returns:

One or more IP ranges.

setIpRanges

public void setIpRanges(Collection<String> ipRanges)

One or more IP ranges.

Parameters:

ipRanges - One or more IP ranges.

withIpRanges

public IpPermission withIpRanges(String... ipRanges)

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

ipRanges - One or more IP ranges.

Returns:

A reference to this updated object so that method calls can be chained together.

withIpRanges

public IpPermission withIpRanges(Collection<String> ipRanges)

One or more IP ranges.

Returns a reference to this object so that method calls can be chained together.

Parameters:

ipRanges - One or more IP ranges.

Returns:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public IpPermission clone()

Overrides:

clone in class Object