com.amazonaws.services.ec2.model.SecurityGroupRuleRequest 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 security group rule.
*
*
* You must specify exactly one of the following parameters, based on the rule type:
*
*
* -
*
* CidrIpv4
*
*
* -
*
* CidrIpv6
*
*
* -
*
* PrefixListId
*
*
* -
*
* ReferencedGroupId
*
*
*
*
* When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you
* must use CidrIpv4 to specify a new IPv4 address range.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SecurityGroupRuleRequest implements Serializable, Cloneable {
/**
*
* The IP protocol name (tcp, udp, icmp, icmpv6) or number (see
* Protocol Numbers).
*
*
* Use -1 to specify all protocols.
*
*/
private String ipProtocol;
/**
*
* 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;
/**
*
* 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 IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
*
*/
private String cidrIpv4;
/**
*
* The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
*
*/
private String cidrIpv6;
/**
*
* The ID of the prefix list.
*
*/
private String prefixListId;
/**
*
* The ID of the security group that is referenced in the security group rule.
*
*/
private String referencedGroupId;
/**
*
* The description of the security group rule.
*
*/
private String description;
/**
*
* The IP protocol name (tcp, udp, icmp, icmpv6) or number (see
* Protocol Numbers).
*
*
* Use -1 to specify all protocols.
*
*
* @param ipProtocol
* The IP protocol name (tcp, udp, icmp, icmpv6) or
* number (see Protocol
* Numbers).
*
* Use -1 to specify all protocols.
*/
public void setIpProtocol(String ipProtocol) {
this.ipProtocol = ipProtocol;
}
/**
*
* The IP protocol name (tcp, udp, icmp, icmpv6) or number (see
* Protocol Numbers).
*
*
* Use -1 to specify all protocols.
*
*
* @return The IP protocol name (tcp, udp, icmp, icmpv6) or
* number (see Protocol
* Numbers).
*
* Use -1 to specify all protocols.
*/
public String getIpProtocol() {
return this.ipProtocol;
}
/**
*
* The IP protocol name (tcp, udp, icmp, icmpv6) or number (see
* Protocol Numbers).
*
*
* Use -1 to specify all protocols.
*
*
* @param ipProtocol
* The IP protocol name (tcp, udp, icmp, icmpv6) or
* number (see Protocol
* Numbers).
*
* Use -1 to specify all protocols.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SecurityGroupRuleRequest withIpProtocol(String ipProtocol) {
setIpProtocol(ipProtocol);
return this;
}
/**
*
* 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 SecurityGroupRuleRequest withFromPort(Integer fromPort) {
setFromPort(fromPort);
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 SecurityGroupRuleRequest withToPort(Integer toPort) {
setToPort(toPort);
return this;
}
/**
*
* The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
*
*
* @param cidrIpv4
* The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
*/
public void setCidrIpv4(String cidrIpv4) {
this.cidrIpv4 = cidrIpv4;
}
/**
*
* The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
*
*
* @return The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
*/
public String getCidrIpv4() {
return this.cidrIpv4;
}
/**
*
* The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
*
*
* @param cidrIpv4
* The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SecurityGroupRuleRequest withCidrIpv4(String cidrIpv4) {
setCidrIpv4(cidrIpv4);
return this;
}
/**
*
* The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
*
*
* @param cidrIpv6
* The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
*/
public void setCidrIpv6(String cidrIpv6) {
this.cidrIpv6 = cidrIpv6;
}
/**
*
* The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
*
*
* @return The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
*/
public String getCidrIpv6() {
return this.cidrIpv6;
}
/**
*
* The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
*
*
* @param cidrIpv6
* The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SecurityGroupRuleRequest withCidrIpv6(String cidrIpv6) {
setCidrIpv6(cidrIpv6);
return this;
}
/**
*
* The ID of the prefix list.
*
*
* @param prefixListId
* The ID of the prefix list.
*/
public void setPrefixListId(String prefixListId) {
this.prefixListId = prefixListId;
}
/**
*
* The ID of the prefix list.
*
*
* @return The ID of the prefix list.
*/
public String getPrefixListId() {
return this.prefixListId;
}
/**
*
* The ID of the prefix list.
*
*
* @param prefixListId
* The ID of the prefix list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SecurityGroupRuleRequest withPrefixListId(String prefixListId) {
setPrefixListId(prefixListId);
return this;
}
/**
*
* The ID of the security group that is referenced in the security group rule.
*
*
* @param referencedGroupId
* The ID of the security group that is referenced in the security group rule.
*/
public void setReferencedGroupId(String referencedGroupId) {
this.referencedGroupId = referencedGroupId;
}
/**
*
* The ID of the security group that is referenced in the security group rule.
*
*
* @return The ID of the security group that is referenced in the security group rule.
*/
public String getReferencedGroupId() {
return this.referencedGroupId;
}
/**
*
* The ID of the security group that is referenced in the security group rule.
*
*
* @param referencedGroupId
* The ID of the security group that is referenced in the security group rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SecurityGroupRuleRequest withReferencedGroupId(String referencedGroupId) {
setReferencedGroupId(referencedGroupId);
return this;
}
/**
*
* The description of the security group rule.
*
*
* @param description
* The description of the security group rule.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the security group rule.
*
*
* @return The description of the security group rule.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the security group rule.
*
*
* @param description
* The description of the security group rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SecurityGroupRuleRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
* 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 (getIpProtocol() != null)
sb.append("IpProtocol: ").append(getIpProtocol()).append(",");
if (getFromPort() != null)
sb.append("FromPort: ").append(getFromPort()).append(",");
if (getToPort() != null)
sb.append("ToPort: ").append(getToPort()).append(",");
if (getCidrIpv4() != null)
sb.append("CidrIpv4: ").append(getCidrIpv4()).append(",");
if (getCidrIpv6() != null)
sb.append("CidrIpv6: ").append(getCidrIpv6()).append(",");
if (getPrefixListId() != null)
sb.append("PrefixListId: ").append(getPrefixListId()).append(",");
if (getReferencedGroupId() != null)
sb.append("ReferencedGroupId: ").append(getReferencedGroupId()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SecurityGroupRuleRequest == false)
return false;
SecurityGroupRuleRequest other = (SecurityGroupRuleRequest) obj;
if (other.getIpProtocol() == null ^ this.getIpProtocol() == null)
return false;
if (other.getIpProtocol() != null && other.getIpProtocol().equals(this.getIpProtocol()) == false)
return false;
if (other.getFromPort() == null ^ this.getFromPort() == null)
return false;
if (other.getFromPort() != null && other.getFromPort().equals(this.getFromPort()) == 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.getCidrIpv4() == null ^ this.getCidrIpv4() == null)
return false;
if (other.getCidrIpv4() != null && other.getCidrIpv4().equals(this.getCidrIpv4()) == false)
return false;
if (other.getCidrIpv6() == null ^ this.getCidrIpv6() == null)
return false;
if (other.getCidrIpv6() != null && other.getCidrIpv6().equals(this.getCidrIpv6()) == false)
return false;
if (other.getPrefixListId() == null ^ this.getPrefixListId() == null)
return false;
if (other.getPrefixListId() != null && other.getPrefixListId().equals(this.getPrefixListId()) == false)
return false;
if (other.getReferencedGroupId() == null ^ this.getReferencedGroupId() == null)
return false;
if (other.getReferencedGroupId() != null && other.getReferencedGroupId().equals(this.getReferencedGroupId()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIpProtocol() == null) ? 0 : getIpProtocol().hashCode());
hashCode = prime * hashCode + ((getFromPort() == null) ? 0 : getFromPort().hashCode());
hashCode = prime * hashCode + ((getToPort() == null) ? 0 : getToPort().hashCode());
hashCode = prime * hashCode + ((getCidrIpv4() == null) ? 0 : getCidrIpv4().hashCode());
hashCode = prime * hashCode + ((getCidrIpv6() == null) ? 0 : getCidrIpv6().hashCode());
hashCode = prime * hashCode + ((getPrefixListId() == null) ? 0 : getPrefixListId().hashCode());
hashCode = prime * hashCode + ((getReferencedGroupId() == null) ? 0 : getReferencedGroupId().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
return hashCode;
}
@Override
public SecurityGroupRuleRequest clone() {
try {
return (SecurityGroupRuleRequest) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}