ResolverRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.route53resolver.model.ResolverRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ResolverRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ResolverRule()

Constructors
Constructor and Description
`ResolverRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResolverRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The ARN (Amazon Resource Name) for the resolver rule specified by `Id`.
`String`	`getCreatorRequestId()` A unique string that you specified when you created the resolver rule.
`String`	`getDomainName()` DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`.
`String`	`getId()` The ID that Resolver assigned to the resolver rule when you created it.
`String`	`getName()` The name for the resolver rule, which you specified when you created the resolver rule.
`String`	`getOwnerId()` When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
`String`	`getResolverEndpointId()` The ID of the endpoint that the rule is associated with.
`String`	`getRuleType()` This value is always `FORWARD`.
`String`	`getShareStatus()` 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`	`getStatus()` A code that specifies the current status of the resolver rule.
`String`	`getStatusMessage()` A detailed description of the status of a resolver rule.
`List<TargetAddress>`	`getTargetIps()` An array that contains the IP addresses and ports that you want to forward
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The ARN (Amazon Resource Name) for the resolver rule specified by `Id`.
`void`	`setCreatorRequestId(String creatorRequestId)` A unique string that you specified when you created the resolver rule.
`void`	`setDomainName(String domainName)` DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`.
`void`	`setId(String id)` The ID that Resolver assigned to the resolver rule when you created it.
`void`	`setName(String name)` The name for the resolver rule, which you specified when you created the resolver rule.
`void`	`setOwnerId(String ownerId)` When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
`void`	`setResolverEndpointId(String resolverEndpointId)` The ID of the endpoint that the rule is associated with.
`void`	`setRuleType(String ruleType)` This value is always `FORWARD`.
`void`	`setShareStatus(String 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.
`void`	`setStatus(String status)` A code that specifies the current status of the resolver rule.
`void`	`setStatusMessage(String statusMessage)` A detailed description of the status of a resolver rule.
`void`	`setTargetIps(Collection<TargetAddress> targetIps)` An array that contains the IP addresses and ports that you want to forward
`String`	`toString()` Returns a string representation of this object.
`ResolverRule`	`withArn(String arn)` The ARN (Amazon Resource Name) for the resolver rule specified by `Id`.
`ResolverRule`	`withCreatorRequestId(String creatorRequestId)` A unique string that you specified when you created the resolver rule.
`ResolverRule`	`withDomainName(String domainName)` DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`.
`ResolverRule`	`withId(String id)` The ID that Resolver assigned to the resolver rule when you created it.
`ResolverRule`	`withName(String name)` The name for the resolver rule, which you specified when you created the resolver rule.
`ResolverRule`	`withOwnerId(String ownerId)` When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
`ResolverRule`	`withResolverEndpointId(String resolverEndpointId)` The ID of the endpoint that the rule is associated with.
`ResolverRule`	`withRuleType(RuleTypeOption ruleType)` This value is always `FORWARD`.
`ResolverRule`	`withRuleType(String ruleType)` This value is always `FORWARD`.
`ResolverRule`	`withShareStatus(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.
`ResolverRule`	`withShareStatus(String 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.
`ResolverRule`	`withStatus(ResolverRuleStatus status)` A code that specifies the current status of the resolver rule.
`ResolverRule`	`withStatus(String status)` A code that specifies the current status of the resolver rule.
`ResolverRule`	`withStatusMessage(String statusMessage)` A detailed description of the status of a resolver rule.
`ResolverRule`	`withTargetIps(Collection<TargetAddress> targetIps)` An array that contains the IP addresses and ports that you want to forward
`ResolverRule`	`withTargetIps(TargetAddress... targetIps)` An array that contains the IP addresses and ports that you want to forward

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

- Constructor Detail
  - ResolverRule
```
public ResolverRule()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The ID that Resolver assigned to the resolver rule when you created it.
    
    Parameters:
    
    id - The ID that Resolver assigned to the resolver rule when you created it.
  - getId
```
public String getId()
```
    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.
  - withId
```
public ResolverRule withId(String id)
```
    The ID that Resolver assigned to the resolver rule when you created it.
    
    Parameters:
    
    id - The ID that Resolver assigned to the resolver rule when you created it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatorRequestId
```
public void setCreatorRequestId(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.
    
    Parameters:
    
    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 executing the operation twice.
  - getCreatorRequestId
```
public String getCreatorRequestId()
```
    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.
  - withCreatorRequestId
```
public ResolverRule withCreatorRequestId(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.
    
    Parameters:
    
    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 executing the operation twice.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The ARN (Amazon Resource Name) for the resolver rule specified by Id.
    
    Parameters:
    
    arn - The ARN (Amazon Resource Name) for the resolver rule specified by Id.
  - getArn
```
public String getArn()
```
    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.
  - withArn
```
public ResolverRule withArn(String arn)
```
    The ARN (Amazon Resource Name) for the resolver rule specified by Id.
    
    Parameters:
    
    arn - The ARN (Amazon Resource Name) for the resolver rule specified by Id.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDomainName
```
public void setDomainName(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).
    
    Parameters:
    
    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).
  - getDomainName
```
public String getDomainName()
```
    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).
  - withDomainName
```
public ResolverRule withDomainName(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    A code that specifies the current status of the resolver rule.
    
    Parameters:
    
    status - A code that specifies the current status of the resolver rule.
    
    See Also:
    
    ResolverRuleStatus
  - getStatus
```
public String getStatus()
```
    A code that specifies the current status of the resolver rule.
    
    Returns:
    
    A code that specifies the current status of the resolver rule.
    
    See Also:
    
    ResolverRuleStatus
  - withStatus
```
public ResolverRule withStatus(String status)
```
    A code that specifies the current status of the resolver rule.
    
    Parameters:
    
    status - A code that specifies the current status of the resolver rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResolverRuleStatus
  - withStatus
```
public ResolverRule withStatus(ResolverRuleStatus status)
```
    A code that specifies the current status of the resolver rule.
    
    Parameters:
    
    status - A code that specifies the current status of the resolver rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResolverRuleStatus
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    A detailed description of the status of a resolver rule.
    
    Parameters:
    
    statusMessage - A detailed description of the status of a resolver rule.
  - getStatusMessage
```
public String getStatusMessage()
```
    A detailed description of the status of a resolver rule.
    
    Returns:
    
    A detailed description of the status of a resolver rule.
  - withStatusMessage
```
public ResolverRule withStatusMessage(String statusMessage)
```
    A detailed description of the status of a resolver rule.
    
    Parameters:
    
    statusMessage - A detailed description of the status of a resolver rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleType
```
public void setRuleType(String ruleType)
```
    This value is always FORWARD. Other resolver rule types aren't supported.
    
    Parameters:
    
    ruleType - This value is always FORWARD. Other resolver rule types aren't supported.
    
    See Also:
    
    RuleTypeOption
  - getRuleType
```
public String getRuleType()
```
    This value is always FORWARD. Other resolver rule types aren't supported.
    
    Returns:
    
    This value is always FORWARD. Other resolver rule types aren't supported.
    
    See Also:
    
    RuleTypeOption
  - withRuleType
```
public ResolverRule withRuleType(String ruleType)
```
    This value is always FORWARD. Other resolver rule types aren't supported.
    
    Parameters:
    
    ruleType - This value is always FORWARD. Other resolver rule types aren't supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleTypeOption
  - withRuleType
```
public ResolverRule withRuleType(RuleTypeOption ruleType)
```
    This value is always FORWARD. Other resolver rule types aren't supported.
    
    Parameters:
    
    ruleType - This value is always FORWARD. Other resolver rule types aren't supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleTypeOption
  - setName
```
public void setName(String name)
```
    The name for the resolver rule, which you specified when you created the resolver rule.
    
    Parameters:
    
    name - The name for the resolver rule, which you specified when you created the resolver rule.
  - getName
```
public String getName()
```
    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.
  - withName
```
public ResolverRule withName(String name)
```
    The name for the resolver rule, which you specified when you created the resolver rule.
    
    Parameters:
    
    name - The name for the resolver rule, which you specified when you created the resolver rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargetIps
```
public List<TargetAddress> getTargetIps()
```
    An array that contains the IP addresses and ports that you want to forward
    
    Returns:
    
    An array that contains the IP addresses and ports that you want to forward
  - setTargetIps
```
public void setTargetIps(Collection<TargetAddress> targetIps)
```
    An array that contains the IP addresses and ports that you want to forward
    
    Parameters:
    
    targetIps - An array that contains the IP addresses and ports that you want to forward
  - withTargetIps
```
public ResolverRule withTargetIps(TargetAddress... targetIps)
```
    An array that contains the IP addresses and ports that you want to forward
    
    NOTE: This method appends the values to the existing list (if any). Use setTargetIps(java.util.Collection) or withTargetIps(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    targetIps - An array that contains the IP addresses and ports that you want to forward
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargetIps
```
public ResolverRule withTargetIps(Collection<TargetAddress> targetIps)
```
    An array that contains the IP addresses and ports that you want to forward
    
    Parameters:
    
    targetIps - An array that contains the IP addresses and ports that you want to forward
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResolverEndpointId
```
public void setResolverEndpointId(String resolverEndpointId)
```
    The ID of the endpoint that the rule is associated with.
    
    Parameters:
    
    resolverEndpointId - The ID of the endpoint that the rule is associated with.
  - getResolverEndpointId
```
public String getResolverEndpointId()
```
    The ID of the endpoint that the rule is associated with.
    
    Returns:
    
    The ID of the endpoint that the rule is associated with.
  - withResolverEndpointId
```
public ResolverRule withResolverEndpointId(String resolverEndpointId)
```
    The ID of the endpoint that the rule is associated with.
    
    Parameters:
    
    resolverEndpointId - The ID of the endpoint that the rule is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwnerId
```
public void setOwnerId(String ownerId)
```
    When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
    
    Parameters:
    
    ownerId - When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
  - getOwnerId
```
public String getOwnerId()
```
    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.
  - withOwnerId
```
public ResolverRule withOwnerId(String ownerId)
```
    When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
    
    Parameters:
    
    ownerId - When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setShareStatus
```
public void setShareStatus(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ShareStatus
  - getShareStatus
```
public String getShareStatus()
```
    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.
    
    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
  - withShareStatus
```
public ResolverRule withShareStatus(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ShareStatus
  - withShareStatus
```
public ResolverRule withShareStatus(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ShareStatus
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ResolverRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ResolverRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResolverRule

Method Detail

setId

getId

withId

setCreatorRequestId

getCreatorRequestId

withCreatorRequestId

setArn

getArn

withArn

setDomainName

getDomainName

withDomainName

setStatus

getStatus

withStatus

withStatus

setStatusMessage

getStatusMessage

withStatusMessage

setRuleType

getRuleType

withRuleType

withRuleType

setName

getName

withName

getTargetIps

setTargetIps

withTargetIps

withTargetIps

setResolverEndpointId

getResolverEndpointId

withResolverEndpointId

setOwnerId

getOwnerId

withOwnerId

setShareStatus

getShareStatus

withShareStatus

withShareStatus

toString

equals

hashCode

clone

marshall