com.amazonaws.services.ec2.model.IpPermission Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Describes a set of permissions for a security group rule.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IpPermission implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private Integer fromPort;
/**
*
* 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.
*
*/
private String ipProtocol;
/**
*
* [VPC only] The IPv6 ranges.
*
*/
private com.amazonaws.internal.SdkInternalList ipv6Ranges;
/**
*
* [VPC only] The prefix list IDs.
*
*/
private com.amazonaws.internal.SdkInternalList prefixListIds;
/**
*
* 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.
*
*/
private Integer toPort;
/**
*
* The security group and Amazon Web Services account ID pairs.
*
*/
private com.amazonaws.internal.SdkInternalList userIdGroupPairs;
/**
*
* The IPv4 ranges.
*
*/
private com.amazonaws.internal.SdkInternalList ipv4Ranges;
/**
*
* 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.
*
*
* @param 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.
*/
public void setFromPort(Integer fromPort) {
this.fromPort = 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.
*
*
* @return 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.
*/
public Integer getFromPort() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withFromPort(Integer fromPort) {
setFromPort(fromPort);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setIpProtocol(String ipProtocol) {
this.ipProtocol = 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.
*
*
* @return 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.
*/
public String getIpProtocol() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withIpProtocol(String ipProtocol) {
setIpProtocol(ipProtocol);
return this;
}
/**
*
* [VPC only] The IPv6 ranges.
*
*
* @return [VPC only] The IPv6 ranges.
*/
public java.util.List getIpv6Ranges() {
if (ipv6Ranges == null) {
ipv6Ranges = new com.amazonaws.internal.SdkInternalList();
}
return ipv6Ranges;
}
/**
*
* [VPC only] The IPv6 ranges.
*
*
* @param ipv6Ranges
* [VPC only] The IPv6 ranges.
*/
public void setIpv6Ranges(java.util.Collection ipv6Ranges) {
if (ipv6Ranges == null) {
this.ipv6Ranges = null;
return;
}
this.ipv6Ranges = new com.amazonaws.internal.SdkInternalList(ipv6Ranges);
}
/**
*
* [VPC only] The IPv6 ranges.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setIpv6Ranges(java.util.Collection)} or {@link #withIpv6Ranges(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param ipv6Ranges
* [VPC only] The IPv6 ranges.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withIpv6Ranges(Ipv6Range... ipv6Ranges) {
if (this.ipv6Ranges == null) {
setIpv6Ranges(new com.amazonaws.internal.SdkInternalList(ipv6Ranges.length));
}
for (Ipv6Range ele : ipv6Ranges) {
this.ipv6Ranges.add(ele);
}
return this;
}
/**
*
* [VPC only] The IPv6 ranges.
*
*
* @param ipv6Ranges
* [VPC only] The IPv6 ranges.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withIpv6Ranges(java.util.Collection ipv6Ranges) {
setIpv6Ranges(ipv6Ranges);
return this;
}
/**
*
* [VPC only] The prefix list IDs.
*
*
* @return [VPC only] The prefix list IDs.
*/
public java.util.List getPrefixListIds() {
if (prefixListIds == null) {
prefixListIds = new com.amazonaws.internal.SdkInternalList();
}
return prefixListIds;
}
/**
*
* [VPC only] The prefix list IDs.
*
*
* @param prefixListIds
* [VPC only] The prefix list IDs.
*/
public void setPrefixListIds(java.util.Collection prefixListIds) {
if (prefixListIds == null) {
this.prefixListIds = null;
return;
}
this.prefixListIds = new com.amazonaws.internal.SdkInternalList(prefixListIds);
}
/**
*
* [VPC only] The prefix list IDs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPrefixListIds(java.util.Collection)} or {@link #withPrefixListIds(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param prefixListIds
* [VPC only] The prefix list IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withPrefixListIds(PrefixListId... prefixListIds) {
if (this.prefixListIds == null) {
setPrefixListIds(new com.amazonaws.internal.SdkInternalList(prefixListIds.length));
}
for (PrefixListId ele : prefixListIds) {
this.prefixListIds.add(ele);
}
return this;
}
/**
*
* [VPC only] The prefix list IDs.
*
*
* @param prefixListIds
* [VPC only] The prefix list IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withPrefixListIds(java.util.Collection prefixListIds) {
setPrefixListIds(prefixListIds);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setToPort(Integer toPort) {
this.toPort = 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.
*
*
* @return 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.
*/
public Integer getToPort() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withToPort(Integer toPort) {
setToPort(toPort);
return this;
}
/**
*
* The security group and Amazon Web Services account ID pairs.
*
*
* @return The security group and Amazon Web Services account ID pairs.
*/
public java.util.List getUserIdGroupPairs() {
if (userIdGroupPairs == null) {
userIdGroupPairs = new com.amazonaws.internal.SdkInternalList();
}
return userIdGroupPairs;
}
/**
*
* The security group and Amazon Web Services account ID pairs.
*
*
* @param userIdGroupPairs
* The security group and Amazon Web Services account ID pairs.
*/
public void setUserIdGroupPairs(java.util.Collection userIdGroupPairs) {
if (userIdGroupPairs == null) {
this.userIdGroupPairs = null;
return;
}
this.userIdGroupPairs = new com.amazonaws.internal.SdkInternalList(userIdGroupPairs);
}
/**
*
* The security group and Amazon Web Services account ID pairs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setUserIdGroupPairs(java.util.Collection)} or {@link #withUserIdGroupPairs(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param userIdGroupPairs
* The security group and Amazon Web Services account ID pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withUserIdGroupPairs(UserIdGroupPair... userIdGroupPairs) {
if (this.userIdGroupPairs == null) {
setUserIdGroupPairs(new com.amazonaws.internal.SdkInternalList(userIdGroupPairs.length));
}
for (UserIdGroupPair ele : userIdGroupPairs) {
this.userIdGroupPairs.add(ele);
}
return this;
}
/**
*
* The security group and Amazon Web Services account ID pairs.
*
*
* @param userIdGroupPairs
* The security group and Amazon Web Services account ID pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withUserIdGroupPairs(java.util.Collection userIdGroupPairs) {
setUserIdGroupPairs(userIdGroupPairs);
return this;
}
/**
*
* The IPv4 ranges.
*
*
* @return The IPv4 ranges.
*/
public java.util.List getIpv4Ranges() {
if (ipv4Ranges == null) {
ipv4Ranges = new com.amazonaws.internal.SdkInternalList();
}
return ipv4Ranges;
}
/**
*
* The IPv4 ranges.
*
*
* @param ipv4Ranges
* The IPv4 ranges.
*/
public void setIpv4Ranges(java.util.Collection ipv4Ranges) {
if (ipv4Ranges == null) {
this.ipv4Ranges = null;
return;
}
this.ipv4Ranges = new com.amazonaws.internal.SdkInternalList(ipv4Ranges);
}
/**
*
* The IPv4 ranges.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setIpv4Ranges(java.util.Collection)} or {@link #withIpv4Ranges(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param ipv4Ranges
* The IPv4 ranges.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withIpv4Ranges(IpRange... ipv4Ranges) {
if (this.ipv4Ranges == null) {
setIpv4Ranges(new com.amazonaws.internal.SdkInternalList(ipv4Ranges.length));
}
for (IpRange ele : ipv4Ranges) {
this.ipv4Ranges.add(ele);
}
return this;
}
/**
*
* The IPv4 ranges.
*
*
* @param ipv4Ranges
* The IPv4 ranges.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IpPermission withIpv4Ranges(java.util.Collection ipv4Ranges) {
setIpv4Ranges(ipv4Ranges);
return this;
}
/**
*
* One or more IP ranges.
*
*
* @return One or more IP ranges.
* @deprecated Use {@link #getIpv4Ranges()}.
*/
@Deprecated
public java.util.List getIpRanges() {
if (ipv4Ranges == null) {
ipv4Ranges = new com.amazonaws.internal.SdkInternalList();
}
return newLegacyIpRangeList(ipv4Ranges);
}
/**
*
* One or more IP ranges.
*
*
* @param ipRanges
* One or more IP ranges.
* @deprecated Use {@link #setIpv4Ranges(java.util.Collection)}
*/
@Deprecated
public void setIpRanges(java.util.Collection ipRanges) {
if (ipRanges == null) {
this.ipv4Ranges = null;
return;
}
this.ipv4Ranges = newIpRangeList(ipRanges);
}
/**
*
* One or more IP ranges.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setIpRanges(java.util.Collection)} or {@link #withIpRanges(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param ipRanges
* One or more IP ranges.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated Use {@link #withIpv4Ranges(IpRange...)}
*/
@Deprecated
public IpPermission withIpRanges(String... ipRanges) {
if (this.ipv4Ranges == null) {
setIpRanges(new com.amazonaws.internal.SdkInternalList(ipRanges.length));
}
for (String ele : ipRanges) {
this.ipv4Ranges.add(newIpRange(ele));
}
return this;
}
/**
*
* One or more IP ranges.
*
*
* @param ipRanges
* One or more IP ranges.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated Use {@link #withIpv4Ranges(java.util.Collection)}
*/
@Deprecated
public IpPermission withIpRanges(java.util.Collection ipRanges) {
setIpRanges(ipRanges);
return this;
}
private IpRange newIpRange(String ipRange) {
return new IpRange().withCidrIp(ipRange);
}
private com.amazonaws.internal.SdkInternalList newIpRangeList(java.util.Collection ipRanges) {
com.amazonaws.internal.SdkInternalList ipRangeList = new com.amazonaws.internal.SdkInternalList(ipRanges.size());
for (String ipRange : ipRanges) {
ipRangeList.add(newIpRange(ipRange));
}
return ipRangeList;
}
private java.util.List newLegacyIpRangeList(java.util.List ipRanges) {
java.util.List ipRangeList = new java.util.ArrayList();
for (IpRange ipRange : ipRanges) {
ipRangeList.add(ipRange.getCidrIp());
}
return ipRangeList;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFromPort() != null)
sb.append("FromPort: ").append(getFromPort()).append(",");
if (getIpProtocol() != null)
sb.append("IpProtocol: ").append(getIpProtocol()).append(",");
if (getIpv6Ranges() != null)
sb.append("Ipv6Ranges: ").append(getIpv6Ranges()).append(",");
if (getPrefixListIds() != null)
sb.append("PrefixListIds: ").append(getPrefixListIds()).append(",");
if (getToPort() != null)
sb.append("ToPort: ").append(getToPort()).append(",");
if (getUserIdGroupPairs() != null)
sb.append("UserIdGroupPairs: ").append(getUserIdGroupPairs()).append(",");
if (getIpv4Ranges() != null)
sb.append("Ipv4Ranges: ").append(getIpv4Ranges());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IpPermission == false)
return false;
IpPermission other = (IpPermission) obj;
if (other.getFromPort() == null ^ this.getFromPort() == null)
return false;
if (other.getFromPort() != null && other.getFromPort().equals(this.getFromPort()) == false)
return false;
if (other.getIpProtocol() == null ^ this.getIpProtocol() == null)
return false;
if (other.getIpProtocol() != null && other.getIpProtocol().equals(this.getIpProtocol()) == false)
return false;
if (other.getIpv6Ranges() == null ^ this.getIpv6Ranges() == null)
return false;
if (other.getIpv6Ranges() != null && other.getIpv6Ranges().equals(this.getIpv6Ranges()) == false)
return false;
if (other.getPrefixListIds() == null ^ this.getPrefixListIds() == null)
return false;
if (other.getPrefixListIds() != null && other.getPrefixListIds().equals(this.getPrefixListIds()) == false)
return false;
if (other.getToPort() == null ^ this.getToPort() == null)
return false;
if (other.getToPort() != null && other.getToPort().equals(this.getToPort()) == false)
return false;
if (other.getUserIdGroupPairs() == null ^ this.getUserIdGroupPairs() == null)
return false;
if (other.getUserIdGroupPairs() != null && other.getUserIdGroupPairs().equals(this.getUserIdGroupPairs()) == false)
return false;
if (other.getIpv4Ranges() == null ^ this.getIpv4Ranges() == null)
return false;
if (other.getIpv4Ranges() != null && other.getIpv4Ranges().equals(this.getIpv4Ranges()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFromPort() == null) ? 0 : getFromPort().hashCode());
hashCode = prime * hashCode + ((getIpProtocol() == null) ? 0 : getIpProtocol().hashCode());
hashCode = prime * hashCode + ((getIpv6Ranges() == null) ? 0 : getIpv6Ranges().hashCode());
hashCode = prime * hashCode + ((getPrefixListIds() == null) ? 0 : getPrefixListIds().hashCode());
hashCode = prime * hashCode + ((getToPort() == null) ? 0 : getToPort().hashCode());
hashCode = prime * hashCode + ((getUserIdGroupPairs() == null) ? 0 : getUserIdGroupPairs().hashCode());
hashCode = prime * hashCode + ((getIpv4Ranges() == null) ? 0 : getIpv4Ranges().hashCode());
return hashCode;
}
@Override
public IpPermission clone() {
try {
return (IpPermission) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}