com.amazonaws.services.ec2.model.CreateNetworkAclEntryRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.CreateNetworkAclEntryRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the
* specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it
* to 100.68.0.0/18.
*
*/
private String cidrBlock;
/**
*
* Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
*
*/
private Boolean egress;
/**
*
* ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6)
* with an IPv6 CIDR block.
*
*/
private IcmpTypeCode icmpTypeCode;
/**
*
* The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
*
*/
private String ipv6CidrBlock;
/**
*
* The ID of the network ACL.
*
*/
private String networkAclId;
/**
*
* TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17
* (UDP).
*
*/
private PortRange portRange;
/**
*
* The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6"
* (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes
* that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP
* types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an
* IPv6 CIDR block, you must specify an ICMP type and code.
*
*/
private String protocol;
/**
*
* Indicates whether to allow or deny the traffic that matches the rule.
*
*/
private String ruleAction;
/**
*
* The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
*
*
* Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
*
*/
private Integer ruleNumber;
/**
*
* The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the
* specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it
* to 100.68.0.0/18.
*
*
* @param cidrBlock
* The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We
* modify the specified CIDR block to its canonical form; for example, if you specify
* 100.68.0.18/18, we modify it to 100.68.0.0/18.
*/
public void setCidrBlock(String cidrBlock) {
this.cidrBlock = cidrBlock;
}
/**
*
* The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the
* specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it
* to 100.68.0.0/18.
*
*
* @return The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We
* modify the specified CIDR block to its canonical form; for example, if you specify
* 100.68.0.18/18, we modify it to 100.68.0.0/18.
*/
public String getCidrBlock() {
return this.cidrBlock;
}
/**
*
* The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the
* specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it
* to 100.68.0.0/18.
*
*
* @param cidrBlock
* The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We
* modify the specified CIDR block to its canonical form; for example, if you specify
* 100.68.0.18/18, we modify it to 100.68.0.0/18.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkAclEntryRequest withCidrBlock(String cidrBlock) {
setCidrBlock(cidrBlock);
return this;
}
/**
*
* Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
*
*
* @param egress
* Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
*/
public void setEgress(Boolean egress) {
this.egress = egress;
}
/**
*
* Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
*
*
* @return Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
*/
public Boolean getEgress() {
return this.egress;
}
/**
*
* Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
*
*
* @param egress
* Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkAclEntryRequest withEgress(Boolean egress) {
setEgress(egress);
return this;
}
/**
*
* Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
*
*
* @return Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
*/
public Boolean isEgress() {
return this.egress;
}
/**
*
* ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6)
* with an IPv6 CIDR block.
*
*
* @param icmpTypeCode
* ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58
* (ICMPv6) with an IPv6 CIDR block.
*/
public void setIcmpTypeCode(IcmpTypeCode icmpTypeCode) {
this.icmpTypeCode = icmpTypeCode;
}
/**
*
* ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6)
* with an IPv6 CIDR block.
*
*
* @return ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58
* (ICMPv6) with an IPv6 CIDR block.
*/
public IcmpTypeCode getIcmpTypeCode() {
return this.icmpTypeCode;
}
/**
*
* ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6)
* with an IPv6 CIDR block.
*
*
* @param icmpTypeCode
* ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58
* (ICMPv6) with an IPv6 CIDR block.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkAclEntryRequest withIcmpTypeCode(IcmpTypeCode icmpTypeCode) {
setIcmpTypeCode(icmpTypeCode);
return this;
}
/**
*
* The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
*
*
* @param ipv6CidrBlock
* The IPv6 network range to allow or deny, in CIDR notation (for example
* 2001:db8:1234:1a00::/64).
*/
public void setIpv6CidrBlock(String ipv6CidrBlock) {
this.ipv6CidrBlock = ipv6CidrBlock;
}
/**
*
* The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
*
*
* @return The IPv6 network range to allow or deny, in CIDR notation (for example
* 2001:db8:1234:1a00::/64).
*/
public String getIpv6CidrBlock() {
return this.ipv6CidrBlock;
}
/**
*
* The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
*
*
* @param ipv6CidrBlock
* The IPv6 network range to allow or deny, in CIDR notation (for example
* 2001:db8:1234:1a00::/64).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkAclEntryRequest withIpv6CidrBlock(String ipv6CidrBlock) {
setIpv6CidrBlock(ipv6CidrBlock);
return this;
}
/**
*
* The ID of the network ACL.
*
*
* @param networkAclId
* The ID of the network ACL.
*/
public void setNetworkAclId(String networkAclId) {
this.networkAclId = networkAclId;
}
/**
*
* The ID of the network ACL.
*
*
* @return The ID of the network ACL.
*/
public String getNetworkAclId() {
return this.networkAclId;
}
/**
*
* The ID of the network ACL.
*
*
* @param networkAclId
* The ID of the network ACL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkAclEntryRequest withNetworkAclId(String networkAclId) {
setNetworkAclId(networkAclId);
return this;
}
/**
*
* TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17
* (UDP).
*
*
* @param portRange
* TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or
* 17 (UDP).
*/
public void setPortRange(PortRange portRange) {
this.portRange = portRange;
}
/**
*
* TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17
* (UDP).
*
*
* @return TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or
* 17 (UDP).
*/
public PortRange getPortRange() {
return this.portRange;
}
/**
*
* TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17
* (UDP).
*
*
* @param portRange
* TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or
* 17 (UDP).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkAclEntryRequest withPortRange(PortRange portRange) {
setPortRange(portRange);
return this;
}
/**
*
* The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6"
* (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes
* that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP
* types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an
* IPv6 CIDR block, you must specify an ICMP type and code.
*
*
* @param protocol
* The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other
* than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or
* ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR
* block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify
* protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
*/
public void setProtocol(String protocol) {
this.protocol = protocol;
}
/**
*
* The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6"
* (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes
* that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP
* types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an
* IPv6 CIDR block, you must specify an ICMP type and code.
*
*
* @return The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other
* than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or
* ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR
* block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify
* protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
*/
public String getProtocol() {
return this.protocol;
}
/**
*
* The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6"
* (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes
* that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP
* types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an
* IPv6 CIDR block, you must specify an ICMP type and code.
*
*
* @param protocol
* The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other
* than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or
* ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR
* block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify
* protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkAclEntryRequest withProtocol(String protocol) {
setProtocol(protocol);
return this;
}
/**
*
* Indicates whether to allow or deny the traffic that matches the rule.
*
*
* @param ruleAction
* Indicates whether to allow or deny the traffic that matches the rule.
* @see RuleAction
*/
public void setRuleAction(String ruleAction) {
this.ruleAction = ruleAction;
}
/**
*
* Indicates whether to allow or deny the traffic that matches the rule.
*
*
* @return Indicates whether to allow or deny the traffic that matches the rule.
* @see RuleAction
*/
public String getRuleAction() {
return this.ruleAction;
}
/**
*
* Indicates whether to allow or deny the traffic that matches the rule.
*
*
* @param ruleAction
* Indicates whether to allow or deny the traffic that matches the rule.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleAction
*/
public CreateNetworkAclEntryRequest withRuleAction(String ruleAction) {
setRuleAction(ruleAction);
return this;
}
/**
*
* Indicates whether to allow or deny the traffic that matches the rule.
*
*
* @param ruleAction
* Indicates whether to allow or deny the traffic that matches the rule.
* @see RuleAction
*/
public void setRuleAction(RuleAction ruleAction) {
withRuleAction(ruleAction);
}
/**
*
* Indicates whether to allow or deny the traffic that matches the rule.
*
*
* @param ruleAction
* Indicates whether to allow or deny the traffic that matches the rule.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleAction
*/
public CreateNetworkAclEntryRequest withRuleAction(RuleAction ruleAction) {
this.ruleAction = ruleAction.toString();
return this;
}
/**
*
* The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
*
*
* Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
*
*
* @param ruleNumber
* The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule
* number.
*
* Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
*/
public void setRuleNumber(Integer ruleNumber) {
this.ruleNumber = ruleNumber;
}
/**
*
* The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
*
*
* Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
*
*
* @return The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule
* number.
*
* Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
*/
public Integer getRuleNumber() {
return this.ruleNumber;
}
/**
*
* The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
*
*
* Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
*
*
* @param ruleNumber
* The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule
* number.
*
* Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkAclEntryRequest withRuleNumber(Integer ruleNumber) {
setRuleNumber(ruleNumber);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new CreateNetworkAclEntryRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getCidrBlock() != null)
sb.append("CidrBlock: ").append(getCidrBlock()).append(",");
if (getEgress() != null)
sb.append("Egress: ").append(getEgress()).append(",");
if (getIcmpTypeCode() != null)
sb.append("IcmpTypeCode: ").append(getIcmpTypeCode()).append(",");
if (getIpv6CidrBlock() != null)
sb.append("Ipv6CidrBlock: ").append(getIpv6CidrBlock()).append(",");
if (getNetworkAclId() != null)
sb.append("NetworkAclId: ").append(getNetworkAclId()).append(",");
if (getPortRange() != null)
sb.append("PortRange: ").append(getPortRange()).append(",");
if (getProtocol() != null)
sb.append("Protocol: ").append(getProtocol()).append(",");
if (getRuleAction() != null)
sb.append("RuleAction: ").append(getRuleAction()).append(",");
if (getRuleNumber() != null)
sb.append("RuleNumber: ").append(getRuleNumber());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateNetworkAclEntryRequest == false)
return false;
CreateNetworkAclEntryRequest other = (CreateNetworkAclEntryRequest) obj;
if (other.getCidrBlock() == null ^ this.getCidrBlock() == null)
return false;
if (other.getCidrBlock() != null && other.getCidrBlock().equals(this.getCidrBlock()) == false)
return false;
if (other.getEgress() == null ^ this.getEgress() == null)
return false;
if (other.getEgress() != null && other.getEgress().equals(this.getEgress()) == false)
return false;
if (other.getIcmpTypeCode() == null ^ this.getIcmpTypeCode() == null)
return false;
if (other.getIcmpTypeCode() != null && other.getIcmpTypeCode().equals(this.getIcmpTypeCode()) == false)
return false;
if (other.getIpv6CidrBlock() == null ^ this.getIpv6CidrBlock() == null)
return false;
if (other.getIpv6CidrBlock() != null && other.getIpv6CidrBlock().equals(this.getIpv6CidrBlock()) == false)
return false;
if (other.getNetworkAclId() == null ^ this.getNetworkAclId() == null)
return false;
if (other.getNetworkAclId() != null && other.getNetworkAclId().equals(this.getNetworkAclId()) == false)
return false;
if (other.getPortRange() == null ^ this.getPortRange() == null)
return false;
if (other.getPortRange() != null && other.getPortRange().equals(this.getPortRange()) == false)
return false;
if (other.getProtocol() == null ^ this.getProtocol() == null)
return false;
if (other.getProtocol() != null && other.getProtocol().equals(this.getProtocol()) == false)
return false;
if (other.getRuleAction() == null ^ this.getRuleAction() == null)
return false;
if (other.getRuleAction() != null && other.getRuleAction().equals(this.getRuleAction()) == false)
return false;
if (other.getRuleNumber() == null ^ this.getRuleNumber() == null)
return false;
if (other.getRuleNumber() != null && other.getRuleNumber().equals(this.getRuleNumber()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCidrBlock() == null) ? 0 : getCidrBlock().hashCode());
hashCode = prime * hashCode + ((getEgress() == null) ? 0 : getEgress().hashCode());
hashCode = prime * hashCode + ((getIcmpTypeCode() == null) ? 0 : getIcmpTypeCode().hashCode());
hashCode = prime * hashCode + ((getIpv6CidrBlock() == null) ? 0 : getIpv6CidrBlock().hashCode());
hashCode = prime * hashCode + ((getNetworkAclId() == null) ? 0 : getNetworkAclId().hashCode());
hashCode = prime * hashCode + ((getPortRange() == null) ? 0 : getPortRange().hashCode());
hashCode = prime * hashCode + ((getProtocol() == null) ? 0 : getProtocol().hashCode());
hashCode = prime * hashCode + ((getRuleAction() == null) ? 0 : getRuleAction().hashCode());
hashCode = prime * hashCode + ((getRuleNumber() == null) ? 0 : getRuleNumber().hashCode());
return hashCode;
}
@Override
public CreateNetworkAclEntryRequest clone() {
return (CreateNetworkAclEntryRequest) super.clone();
}
}