software.amazon.awssdk.services.route53resolver.model

Class ResolverRule

java.lang.Object

software.amazon.awssdk.services.route53resolver.model.ResolverRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ResolverRule.Builder,ResolverRule>

@Generated(value="software.amazon.awssdk:codegen")
public final class ResolverRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ResolverRule.Builder,ResolverRule>

For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResolverRule.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN (Amazon Resource Name) for the Resolver rule specified by Id.
static ResolverRule.Builder	builder()
String	creationTime() The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).
String	creatorRequestId() A unique string that you specified when you created the Resolver rule.
String	domainName() DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargetIps() For responses, this returns true if the service returned a value for the TargetIps property.
String	id() The ID that Resolver assigned to the Resolver rule when you created it.
String	modificationTime() The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).
String	name() The name for the Resolver rule, which you specified when you created the Resolver rule.
String	ownerId() When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.
String	resolverEndpointId() The ID of the endpoint that the rule is associated with.
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 ResolverRule.Builder>	serializableBuilderClass()
ShareStatus	shareStatus() Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.
String	shareStatusAsString() Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.
ResolverRuleStatus	status() A code that specifies the current status of the Resolver rule.
String	statusAsString() A code that specifies the current status of the Resolver rule.
String	statusMessage() A detailed description of the status of a Resolver rule.
List<TargetAddress>	targetIps() An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to.
ResolverRule.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

id

public final String id()

The ID that Resolver assigned to the Resolver rule when you created it.

Returns:

The ID that Resolver assigned to the Resolver rule when you created it.

creatorRequestId

public final String creatorRequestId()

A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running the operation twice.

Returns:

A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running the operation twice.

arn

public final String arn()

The ARN (Amazon Resource Name) for the Resolver rule specified by Id.

Returns:

The ARN (Amazon Resource Name) for the Resolver rule specified by Id.

domainName

public final String domainName()

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), the query is 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 are specified in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

status

public final ResolverRuleStatus status()

A code that specifies the current status of the Resolver rule.

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

Returns:

A code that specifies the current status of the Resolver rule.

See Also:

ResolverRuleStatus

statusAsString

public final String statusAsString()

A code that specifies the current status of the Resolver rule.

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

Returns:

A code that specifies the current status of the Resolver rule.

See Also:

ResolverRuleStatus

statusMessage

public final String statusMessage()

A detailed description of the status of a Resolver rule.

Returns:

A detailed description of the status of a Resolver rule.

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

name

public final String name()

The name for the Resolver rule, which you specified when you created the Resolver rule.

Returns:

The name for the Resolver rule, which you specified when you created the Resolver rule.

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

An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

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:

An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

resolverEndpointId

public final String resolverEndpointId()

The ID of the endpoint that the rule is associated with.

Returns:

The ID of the endpoint that the rule is associated with.

ownerId

public final String ownerId()

When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.

Returns:

When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.

shareStatus

public final ShareStatus shareStatus()

Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

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

Returns:

Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

See Also:

ShareStatus

shareStatusAsString

public final String shareStatusAsString()

Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

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

Returns:

Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

See Also:

ShareStatus

creationTime

public final String creationTime()

The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

Returns:

The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

modificationTime

public final String modificationTime()

The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

Returns:

The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

toBuilder

public ResolverRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResolverRule.Builder,ResolverRule>

builder

public static ResolverRule.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo