software.amazon.awssdk.services.route53resolver.model

Class CreateResolverRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.route53resolver.model.Route53ResolverRequest

software.amazon.awssdk.services.route53resolver.model.CreateResolverRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateResolverRuleRequest.Builder,CreateResolverRuleRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateResolverRuleRequest
extends Route53ResolverRequest
implements ToCopyableBuilder<CreateResolverRuleRequest.Builder,CreateResolverRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateResolverRuleRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateResolverRuleRequest.Builder	builder()
String	creatorRequestId() A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.
String	domainName() DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasTargetIps() For responses, this returns true if the service returned a value for the TargetIps property.
String	name() A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
String	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.
RuleTypeOption	ruleType() When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.
String	ruleTypeAsString() When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateResolverRuleRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of the tag keys and values that you want to associate with the endpoint.
List<TargetAddress>	targetIps() The IPs that you want Resolver to forward DNS queries to.
CreateResolverRuleRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

creatorRequestId

public final String 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.

Returns:

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.

name

public final String name()

A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

Returns:

A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

ruleType

public final RuleTypeOption 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.

If the service returns an enum value that is not available in the current SDK version, ruleType will return RuleTypeOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ruleTypeAsString().

Returns:

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 Also:

RuleTypeOption

ruleTypeAsString

public final String ruleTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, ruleType will return RuleTypeOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ruleTypeAsString().

Returns:

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 Also:

RuleTypeOption

domainName

public final String 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).

Returns:

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

hasTargetIps

public final boolean hasTargetIps()

For responses, this returns true if the service returned a value for the TargetIps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

targetIps

public final List<TargetAddress> targetIps()

The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.

TargetIps is available only when the value of Rule type is FORWARD.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetIps() method.

Returns:

The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.

TargetIps is available only when the value of Rule type is FORWARD.

resolverEndpointId

public final String 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.

Returns:

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

A list of the tag keys and values that you want to associate with the endpoint.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of the tag keys and values that you want to associate with the endpoint.

toBuilder

public CreateResolverRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateResolverRuleRequest.Builder,CreateResolverRuleRequest>

Specified by:

toBuilder in class Route53ResolverRequest

builder

public static CreateResolverRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateResolverRuleRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo