All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.ec2.model.IpPermission Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon EC2 module holds the client classes that are used for communicating with Amazon EC2 Service

There is a newer version: 1.12.765
Show newest version
/*
 * Copyright 2012-2017 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 security group rule. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class IpPermission implements Serializable, Cloneable { /** *

* 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. *

*/ private Integer fromPort; /** *

* 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. *

*/ private String ipProtocol; /** *

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

*/ private com.amazonaws.internal.SdkInternalList ipv6Ranges; /** *

* (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. *

*/ private com.amazonaws.internal.SdkInternalList prefixListIds; /** *

* 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. *

*/ private Integer toPort; /** *

* One or more security group and AWS account ID pairs. *

*/ private com.amazonaws.internal.SdkInternalList userIdGroupPairs; /** *

* One or more IPv4 ranges. *

*/ private com.amazonaws.internal.SdkInternalList ipv4Ranges; /** *

* 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. *

* * @param 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. */ public void setFromPort(Integer fromPort) { this.fromPort = 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. *

* * @return 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. */ public Integer getFromPort() { return this.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. *

* * @param 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. * @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) 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. *

* * @param 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. */ public void setIpProtocol(String ipProtocol) { this.ipProtocol = 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. *

* * @return 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. */ public String getIpProtocol() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public IpPermission withIpProtocol(String ipProtocol) { setIpProtocol(ipProtocol); return this; } /** *

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

* * @return [EC2-VPC only] One or more IPv6 ranges. */ public java.util.List getIpv6Ranges() { if (ipv6Ranges == null) { ipv6Ranges = new com.amazonaws.internal.SdkInternalList(); } return ipv6Ranges; } /** *

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

* * @param ipv6Ranges * [EC2-VPC only] One or more IPv6 ranges. */ public void setIpv6Ranges(java.util.Collection ipv6Ranges) { if (ipv6Ranges == null) { this.ipv6Ranges = null; return; } this.ipv6Ranges = new com.amazonaws.internal.SdkInternalList(ipv6Ranges); } /** *

* [EC2-VPC only] One or more 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 * [EC2-VPC only] One or more 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; } /** *

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

* * @param ipv6Ranges * [EC2-VPC only] One or more 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; } /** *

* (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. *

* * @return (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. */ public java.util.List getPrefixListIds() { if (prefixListIds == null) { prefixListIds = new com.amazonaws.internal.SdkInternalList(); } return 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. *

* * @param 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. */ public void setPrefixListIds(java.util.Collection prefixListIds) { if (prefixListIds == null) { this.prefixListIds = null; return; } this.prefixListIds = new com.amazonaws.internal.SdkInternalList(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 * {@link #setPrefixListIds(java.util.Collection)} or {@link #withPrefixListIds(java.util.Collection)} if you want * to override the existing values. *

* * @param 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. * @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; } /** *

* (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. *

* * @param 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. * @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; } /** *

* 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. *

* * @param 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. */ public void setToPort(Integer toPort) { this.toPort = 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. *

* * @return 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. */ public Integer getToPort() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public IpPermission withToPort(Integer toPort) { setToPort(toPort); return this; } /** *

* One or more security group and AWS account ID pairs. *

* * @return One or more security group and AWS account ID pairs. */ public java.util.List getUserIdGroupPairs() { if (userIdGroupPairs == null) { userIdGroupPairs = new com.amazonaws.internal.SdkInternalList(); } return userIdGroupPairs; } /** *

* One or more security group and AWS account ID pairs. *

* * @param userIdGroupPairs * One or more security group and AWS 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); } /** *

* One or more security group and AWS 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 * One or more security group and AWS 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; } /** *

* One or more security group and AWS account ID pairs. *

* * @param userIdGroupPairs * One or more security group and AWS 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; } /** *

* One or more IPv4 ranges. *

* * @return One or more IPv4 ranges. */ public java.util.List getIpv4Ranges() { if (ipv4Ranges == null) { ipv4Ranges = new com.amazonaws.internal.SdkInternalList(); } return ipv4Ranges; } /** *

* One or more IPv4 ranges. *

* * @param ipv4Ranges * One or more IPv4 ranges. */ public void setIpv4Ranges(java.util.Collection ipv4Ranges) { if (ipv4Ranges == null) { this.ipv4Ranges = null; return; } this.ipv4Ranges = new com.amazonaws.internal.SdkInternalList(ipv4Ranges); } /** *

* One or more 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 * One or more 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; } /** *

* One or more IPv4 ranges. *

* * @param ipv4Ranges * One or more 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; useful for testing and debugging. * * @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); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy