com.amazonaws.services.waf.model.IPSetDescriptor Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf 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.waf.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
*
* This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
* developer guide.
*
*
* For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the
* latest version, AWS WAF has a single set of endpoints for regional and global use.
*
*
*
* Specifies the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that
* web requests originate from.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IPSetDescriptor implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specify IPV4 or IPV6.
*
*/
private String type;
/**
*
* Specify an IPv4 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify
* 192.0.2.44/32.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to
* 192.0.2.255, specify 192.0.2.0/24.
*
*
*
*
* For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
*
*
* Specify an IPv6 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address
* 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses
* 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
* 1111:0000:0000:0000:0000:0000:0000:0000/64.
*
*
*
*/
private String value;
/**
*
* Specify IPV4 or IPV6.
*
*
* @param type
* Specify IPV4 or IPV6.
* @see IPSetDescriptorType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Specify IPV4 or IPV6.
*
*
* @return Specify IPV4 or IPV6.
* @see IPSetDescriptorType
*/
public String getType() {
return this.type;
}
/**
*
* Specify IPV4 or IPV6.
*
*
* @param type
* Specify IPV4 or IPV6.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IPSetDescriptorType
*/
public IPSetDescriptor withType(String type) {
setType(type);
return this;
}
/**
*
* Specify IPV4 or IPV6.
*
*
* @param type
* Specify IPV4 or IPV6.
* @see IPSetDescriptorType
*/
public void setType(IPSetDescriptorType type) {
withType(type);
}
/**
*
* Specify IPV4 or IPV6.
*
*
* @param type
* Specify IPV4 or IPV6.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IPSetDescriptorType
*/
public IPSetDescriptor withType(IPSetDescriptorType type) {
this.type = type.toString();
return this;
}
/**
*
* Specify an IPv4 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify
* 192.0.2.44/32.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to
* 192.0.2.255, specify 192.0.2.0/24.
*
*
*
*
* For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
*
*
* Specify an IPv6 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address
* 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses
* 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
* 1111:0000:0000:0000:0000:0000:0000:0000/64.
*
*
*
*
* @param value
* Specify an IPv4 address by using CIDR notation. For example:
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44,
* specify 192.0.2.44/32.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0
* to 192.0.2.255, specify 192.0.2.0/24.
*
*
*
*
* For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
*
*
* Specify an IPv6 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address
* 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses
* 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
* 1111:0000:0000:0000:0000:0000:0000:0000/64.
*
*
*/
public void setValue(String value) {
this.value = value;
}
/**
*
* Specify an IPv4 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify
* 192.0.2.44/32.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to
* 192.0.2.255, specify 192.0.2.0/24.
*
*
*
*
* For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
*
*
* Specify an IPv6 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address
* 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses
* 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
* 1111:0000:0000:0000:0000:0000:0000:0000/64.
*
*
*
*
* @return Specify an IPv4 address by using CIDR notation. For example:
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44,
* specify 192.0.2.44/32.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0
* to 192.0.2.255, specify 192.0.2.0/24.
*
*
*
*
* For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
*
*
* Specify an IPv6 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address
* 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128
* .
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses
* 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
* 1111:0000:0000:0000:0000:0000:0000:0000/64.
*
*
*/
public String getValue() {
return this.value;
}
/**
*
* Specify an IPv4 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify
* 192.0.2.44/32.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to
* 192.0.2.255, specify 192.0.2.0/24.
*
*
*
*
* For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
*
*
* Specify an IPv6 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address
* 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses
* 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
* 1111:0000:0000:0000:0000:0000:0000:0000/64.
*
*
*
*
* @param value
* Specify an IPv4 address by using CIDR notation. For example:
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44,
* specify 192.0.2.44/32.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0
* to 192.0.2.255, specify 192.0.2.0/24.
*
*
*
*
* For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
*
*
* Specify an IPv6 address by using CIDR notation. For example:
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from the IP address
* 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
*
*
* -
*
* To configure AWS WAF to allow, block, or count requests that originated from IP addresses
* 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
* 1111:0000:0000:0000:0000:0000:0000:0000/64.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IPSetDescriptor withValue(String value) {
setValue(value);
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 (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IPSetDescriptor == false)
return false;
IPSetDescriptor other = (IPSetDescriptor) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
return hashCode;
}
@Override
public IPSetDescriptor clone() {
try {
return (IPSetDescriptor) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.waf.model.waf_regional.transform.IPSetDescriptorMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}