ResolverRule (AWS SDK for Java

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ResolverRule.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` The ID that Resolver assigned to the resolver rule when you created it.
`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 AWS 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()` This value is always `FORWARD`.
`String`	`ruleTypeAsString()` This value is always `FORWARD`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ResolverRule.Builder>`	`serializableBuilderClass()`
`ShareStatus`	`shareStatus()` Whether the rules 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 rules 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 you want to forward
`ResolverRule.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - id
```
public 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 String creatorRequestId()
```
    A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing 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 executing the operation twice.
  - arn
```
public 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 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 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 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 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 RuleTypeOption ruleType()
```
    This value is always FORWARD. Other resolver rule types aren't supported.
    
    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:
    
    This value is always FORWARD. Other resolver rule types aren't supported.
    
    See Also:
    
    RuleTypeOption
  - ruleTypeAsString
```
public String ruleTypeAsString()
```
    This value is always FORWARD. Other resolver rule types aren't supported.
    
    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:
    
    This value is always FORWARD. Other resolver rule types aren't supported.
    
    See Also:
    
    RuleTypeOption
  - name
```
public 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.
  - targetIps
```
public List<TargetAddress> targetIps()
```
    An array that contains the IP addresses and ports that you want to forward
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    An array that contains the IP addresses and ports that you want to forward
  - resolverEndpointId
```
public 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 String ownerId()
```
    When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
    
    Returns:
    
    When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
  - shareStatus
```
public ShareStatus shareStatus()
```
    Whether the rules 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 rules 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 String shareStatusAsString()
```
    Whether the rules 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 rules 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
  - toBuilder
```
public ResolverRule.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ResolverRule.Builder,ResolverRule>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ResolverRule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ResolverRule.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ResolverRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

creatorRequestId

arn

domainName

status

statusAsString

statusMessage

ruleType

ruleTypeAsString

name

targetIps

resolverEndpointId

ownerId

shareStatus

shareStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields