com.amazonaws.services.route53resolver.model.CreateResolverRuleRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-route53resolver Show documentation
/*
* Copyright 2016-2021 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.route53resolver.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateResolverRuleRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique string that identifies the request and that allows failed requests to be retried without the risk of
* running the operation twice. CreatorRequestId can be any unique string, for example, a date/time
* stamp.
*
*/
private String creatorRequestId;
/**
*
* A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
*
*/
private String name;
/**
*
* When you want to forward DNS queries for specified domain name to resolvers on your network, specify
* FORWARD.
*
*
* When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to
* process queries for a subdomain of that domain, specify SYSTEM.
*
*
* For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
* FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you
* create a rule and specify SYSTEM for RuleType.
*
*
* Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
*
*/
private String ruleType;
/**
*
* DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If
* a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using
* the Resolver rule that contains the most specific domain name (www.example.com).
*
*/
private String domainName;
/**
*
* The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP
* addresses with a space.
*
*
* TargetIps is available only when the value of Rule type is FORWARD.
*
*/
private java.util.List targetIps;
/**
*
* The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you
* specify in TargetIps.
*
*/
private String resolverEndpointId;
/**
*
* A list of the tag keys and values that you want to associate with the endpoint.
*
*/
private java.util.List tags;
/**
*
* A unique string that identifies the request and that allows failed requests to be retried without the risk of
* running the operation twice. CreatorRequestId can be any unique string, for example, a date/time
* stamp.
*
*
* @param creatorRequestId
* A unique string that identifies the request and that allows failed requests to be retried without the risk
* of running the operation twice. CreatorRequestId can be any unique string, for example, a
* date/time stamp.
*/
public void setCreatorRequestId(String creatorRequestId) {
this.creatorRequestId = creatorRequestId;
}
/**
*
* A unique string that identifies the request and that allows failed requests to be retried without the risk of
* running the operation twice. CreatorRequestId can be any unique string, for example, a date/time
* stamp.
*
*
* @return A unique string that identifies the request and that allows failed requests to be retried without the
* risk of running the operation twice. CreatorRequestId can be any unique string, for example,
* a date/time stamp.
*/
public String getCreatorRequestId() {
return this.creatorRequestId;
}
/**
*
* A unique string that identifies the request and that allows failed requests to be retried without the risk of
* running the operation twice. CreatorRequestId can be any unique string, for example, a date/time
* stamp.
*
*
* @param creatorRequestId
* A unique string that identifies the request and that allows failed requests to be retried without the risk
* of running the operation twice. CreatorRequestId can be any unique string, for example, a
* date/time stamp.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResolverRuleRequest withCreatorRequestId(String creatorRequestId) {
setCreatorRequestId(creatorRequestId);
return this;
}
/**
*
* A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
*
*
* @param name
* A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
*
*
* @return A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
*
*
* @param name
* A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResolverRuleRequest withName(String name) {
setName(name);
return this;
}
/**
*
* When you want to forward DNS queries for specified domain name to resolvers on your network, specify
* FORWARD.
*
*
* When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to
* process queries for a subdomain of that domain, specify SYSTEM.
*
*
* For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
* FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you
* create a rule and specify SYSTEM for RuleType.
*
*
* Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
*
*
* @param ruleType
* When you want to forward DNS queries for specified domain name to resolvers on your network, specify
* FORWARD.
*
* When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver
* to process queries for a subdomain of that domain, specify SYSTEM.
*
*
* For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and
* specify FORWARD for RuleType. To then have Resolver process queries for
* apex.example.com, you create a rule and specify SYSTEM for RuleType.
*
*
* Currently, only Resolver can create rules that have a value of RECURSIVE for
* RuleType.
* @see RuleTypeOption
*/
public void setRuleType(String ruleType) {
this.ruleType = ruleType;
}
/**
*
* When you want to forward DNS queries for specified domain name to resolvers on your network, specify
* FORWARD.
*
*
* When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to
* process queries for a subdomain of that domain, specify SYSTEM.
*
*
* For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
* FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you
* create a rule and specify SYSTEM for RuleType.
*
*
* Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
*
*
* @return When you want to forward DNS queries for specified domain name to resolvers on your network, specify
* FORWARD.
*
* When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver
* to process queries for a subdomain of that domain, specify SYSTEM.
*
*
* For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and
* specify FORWARD for RuleType. To then have Resolver process queries for
* apex.example.com, you create a rule and specify SYSTEM for RuleType.
*
*
* Currently, only Resolver can create rules that have a value of RECURSIVE for
* RuleType.
* @see RuleTypeOption
*/
public String getRuleType() {
return this.ruleType;
}
/**
*
* When you want to forward DNS queries for specified domain name to resolvers on your network, specify
* FORWARD.
*
*
* When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to
* process queries for a subdomain of that domain, specify SYSTEM.
*
*
* For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
* FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you
* create a rule and specify SYSTEM for RuleType.
*
*
* Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
*
*
* @param ruleType
* When you want to forward DNS queries for specified domain name to resolvers on your network, specify
* FORWARD.
*
* When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver
* to process queries for a subdomain of that domain, specify SYSTEM.
*
*
* For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and
* specify FORWARD for RuleType. To then have Resolver process queries for
* apex.example.com, you create a rule and specify SYSTEM for RuleType.
*
*
* Currently, only Resolver can create rules that have a value of RECURSIVE for
* RuleType.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleTypeOption
*/
public CreateResolverRuleRequest withRuleType(String ruleType) {
setRuleType(ruleType);
return this;
}
/**
*
* When you want to forward DNS queries for specified domain name to resolvers on your network, specify
* FORWARD.
*
*
* When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to
* process queries for a subdomain of that domain, specify SYSTEM.
*
*
* For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
* FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you
* create a rule and specify SYSTEM for RuleType.
*
*
* Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
*
*
* @param ruleType
* When you want to forward DNS queries for specified domain name to resolvers on your network, specify
* FORWARD.
*
* When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver
* to process queries for a subdomain of that domain, specify SYSTEM.
*
*
* For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and
* specify FORWARD for RuleType. To then have Resolver process queries for
* apex.example.com, you create a rule and specify SYSTEM for RuleType.
*
*
* Currently, only Resolver can create rules that have a value of RECURSIVE for
* RuleType.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleTypeOption
*/
public CreateResolverRuleRequest withRuleType(RuleTypeOption ruleType) {
this.ruleType = ruleType.toString();
return this;
}
/**
*
* DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If
* a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using
* the Resolver rule that contains the most specific domain name (www.example.com).
*
*
* @param domainName
* DNS queries for this domain name are forwarded to the IP addresses that you specify in
* TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com),
* outbound DNS queries are routed using the Resolver rule that contains the most specific domain name
* (www.example.com).
*/
public void setDomainName(String domainName) {
this.domainName = domainName;
}
/**
*
* DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If
* a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using
* the Resolver rule that contains the most specific domain name (www.example.com).
*
*
* @return DNS queries for this domain name are forwarded to the IP addresses that you specify in
* TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com),
* outbound DNS queries are routed using the Resolver rule that contains the most specific domain name
* (www.example.com).
*/
public String getDomainName() {
return this.domainName;
}
/**
*
* DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If
* a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using
* the Resolver rule that contains the most specific domain name (www.example.com).
*
*
* @param domainName
* DNS queries for this domain name are forwarded to the IP addresses that you specify in
* TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com),
* outbound DNS queries are routed using the Resolver rule that contains the most specific domain name
* (www.example.com).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResolverRuleRequest withDomainName(String domainName) {
setDomainName(domainName);
return this;
}
/**
*
* The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP
* addresses with a space.
*
*
* TargetIps is available only when the value of Rule type is FORWARD.
*
*
* @return The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate
* IP addresses with a space.
*
* TargetIps is available only when the value of Rule type is FORWARD.
*/
public java.util.List getTargetIps() {
return targetIps;
}
/**
*
* The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP
* addresses with a space.
*
*
* TargetIps is available only when the value of Rule type is FORWARD.
*
*
* @param targetIps
* The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP
* addresses with a space.
*
* TargetIps is available only when the value of Rule type is FORWARD.
*/
public void setTargetIps(java.util.Collection targetIps) {
if (targetIps == null) {
this.targetIps = null;
return;
}
this.targetIps = new java.util.ArrayList(targetIps);
}
/**
*
* The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP
* addresses with a space.
*
*
* TargetIps is available only when the value of Rule type is FORWARD.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTargetIps(java.util.Collection)} or {@link #withTargetIps(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param targetIps
* The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP
* addresses with a space.
*
* TargetIps is available only when the value of Rule type is FORWARD.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResolverRuleRequest withTargetIps(TargetAddress... targetIps) {
if (this.targetIps == null) {
setTargetIps(new java.util.ArrayList(targetIps.length));
}
for (TargetAddress ele : targetIps) {
this.targetIps.add(ele);
}
return this;
}
/**
*
* The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP
* addresses with a space.
*
*
* TargetIps is available only when the value of Rule type is FORWARD.
*
*
* @param targetIps
* The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP
* addresses with a space.
*
* TargetIps is available only when the value of Rule type is FORWARD.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResolverRuleRequest withTargetIps(java.util.Collection targetIps) {
setTargetIps(targetIps);
return this;
}
/**
*
* The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you
* specify in TargetIps.
*
*
* @param resolverEndpointId
* The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses
* that you specify in TargetIps.
*/
public void setResolverEndpointId(String resolverEndpointId) {
this.resolverEndpointId = resolverEndpointId;
}
/**
*
* The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you
* specify in TargetIps.
*
*
* @return The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses
* that you specify in TargetIps.
*/
public String getResolverEndpointId() {
return this.resolverEndpointId;
}
/**
*
* The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you
* specify in TargetIps.
*
*
* @param resolverEndpointId
* The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses
* that you specify in TargetIps.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResolverRuleRequest withResolverEndpointId(String resolverEndpointId) {
setResolverEndpointId(resolverEndpointId);
return this;
}
/**
*
* A list of the tag keys and values that you want to associate with the endpoint.
*
*
* @return A list of the tag keys and values that you want to associate with the endpoint.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of the tag keys and values that you want to associate with the endpoint.
*
*
* @param tags
* A list of the tag keys and values that you want to associate with the endpoint.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of the tag keys and values that you want to associate with the endpoint.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of the tag keys and values that you want to associate with the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResolverRuleRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of the tag keys and values that you want to associate with the endpoint.
*
*
* @param tags
* A list of the tag keys and values that you want to associate with the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateResolverRuleRequest withTags(java.util.Collection tags) {
setTags(tags);
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 (getCreatorRequestId() != null)
sb.append("CreatorRequestId: ").append(getCreatorRequestId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getRuleType() != null)
sb.append("RuleType: ").append(getRuleType()).append(",");
if (getDomainName() != null)
sb.append("DomainName: ").append(getDomainName()).append(",");
if (getTargetIps() != null)
sb.append("TargetIps: ").append(getTargetIps()).append(",");
if (getResolverEndpointId() != null)
sb.append("ResolverEndpointId: ").append(getResolverEndpointId()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateResolverRuleRequest == false)
return false;
CreateResolverRuleRequest other = (CreateResolverRuleRequest) obj;
if (other.getCreatorRequestId() == null ^ this.getCreatorRequestId() == null)
return false;
if (other.getCreatorRequestId() != null && other.getCreatorRequestId().equals(this.getCreatorRequestId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getRuleType() == null ^ this.getRuleType() == null)
return false;
if (other.getRuleType() != null && other.getRuleType().equals(this.getRuleType()) == false)
return false;
if (other.getDomainName() == null ^ this.getDomainName() == null)
return false;
if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false)
return false;
if (other.getTargetIps() == null ^ this.getTargetIps() == null)
return false;
if (other.getTargetIps() != null && other.getTargetIps().equals(this.getTargetIps()) == false)
return false;
if (other.getResolverEndpointId() == null ^ this.getResolverEndpointId() == null)
return false;
if (other.getResolverEndpointId() != null && other.getResolverEndpointId().equals(this.getResolverEndpointId()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCreatorRequestId() == null) ? 0 : getCreatorRequestId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getRuleType() == null) ? 0 : getRuleType().hashCode());
hashCode = prime * hashCode + ((getDomainName() == null) ? 0 : getDomainName().hashCode());
hashCode = prime * hashCode + ((getTargetIps() == null) ? 0 : getTargetIps().hashCode());
hashCode = prime * hashCode + ((getResolverEndpointId() == null) ? 0 : getResolverEndpointId().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateResolverRuleRequest clone() {
return (CreateResolverRuleRequest) super.clone();
}
}