@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonRoute53ResolverClient extends AmazonWebServiceClient implements AmazonRoute53Resolver
Here's how you set up to query an Amazon Route 53 private hosted zone from your network:
Connect your network to a VPC using AWS Direct Connect or a VPN.
Run the following AWS CLI command to create a Resolver endpoint:
create-resolver-endpoint --name [endpoint_name] --direction INBOUND --creator-request-id [unique_string] --security-group-ids [security_group_with_inbound_rules] --ip-addresses SubnetId=[subnet_id] SubnetId=[subnet_id_in_different_AZ]
Note the resolver endpoint ID that appears in the response. You'll use it in step 3.
Get the IP addresses for the Resolver endpoints:
get-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]
In your network configuration, define the IP addresses that you got in step 3 as DNS servers.
You can now query instance names in your VPCs and the names of records in your private hosted zone.
You can also perform the following operations using the AWS CLI:
list-resolver-endpoints
: List all endpoints. The syntax includes options for pagination and filtering.
update-resolver-endpoints
: Add IP addresses to an endpoint or remove IP addresses from an endpoint.
To delete an endpoint, use the following AWS CLI command:
delete-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateResolverEndpointIpAddressResult |
associateResolverEndpointIpAddress(AssociateResolverEndpointIpAddressRequest request)
Adds IP addresses to an inbound or an outbound resolver endpoint.
|
AssociateResolverRuleResult |
associateResolverRule(AssociateResolverRuleRequest request)
Associates a resolver rule with a VPC.
|
static AmazonRoute53ResolverClientBuilder |
builder() |
CreateResolverEndpointResult |
createResolverEndpoint(CreateResolverEndpointRequest request)
Creates a resolver endpoint.
|
CreateResolverRuleResult |
createResolverRule(CreateResolverRuleRequest request)
For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one
domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.
|
DeleteResolverEndpointResult |
deleteResolverEndpoint(DeleteResolverEndpointRequest request)
Deletes a resolver endpoint.
|
DeleteResolverRuleResult |
deleteResolverRule(DeleteResolverRuleRequest request)
Deletes a resolver rule.
|
DisassociateResolverEndpointIpAddressResult |
disassociateResolverEndpointIpAddress(DisassociateResolverEndpointIpAddressRequest request)
Removes IP addresses from an inbound or an outbound resolver endpoint.
|
DisassociateResolverRuleResult |
disassociateResolverRule(DisassociateResolverRuleRequest request)
Removes the association between a specified resolver rule and a specified VPC.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetResolverEndpointResult |
getResolverEndpoint(GetResolverEndpointRequest request)
Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver
endpoint, and the current status of the endpoint.
|
GetResolverRuleResult |
getResolverRule(GetResolverRuleRequest request)
Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for
and the ID of the outbound resolver endpoint that the rule is associated with.
|
GetResolverRuleAssociationResult |
getResolverRuleAssociation(GetResolverRuleAssociationRequest request)
Gets information about an association between a specified resolver rule and a VPC.
|
GetResolverRulePolicyResult |
getResolverRulePolicy(GetResolverRulePolicyRequest request)
Gets information about a resolver rule policy.
|
ListResolverEndpointIpAddressesResult |
listResolverEndpointIpAddresses(ListResolverEndpointIpAddressesRequest request)
Gets the IP addresses for a specified resolver endpoint.
|
ListResolverEndpointsResult |
listResolverEndpoints(ListResolverEndpointsRequest request)
Lists all the resolver endpoints that were created using the current AWS account.
|
ListResolverRuleAssociationsResult |
listResolverRuleAssociations(ListResolverRuleAssociationsRequest request)
Lists the associations that were created between resolver rules and VPCs using the current AWS account.
|
ListResolverRulesResult |
listResolverRules(ListResolverRulesRequest request)
Lists the resolver rules that were created using the current AWS account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags that you associated with the specified resource.
|
PutResolverRulePolicyResult |
putResolverRulePolicy(PutResolverRulePolicyRequest request)
Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to a specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from a specified resource.
|
UpdateResolverEndpointResult |
updateResolverEndpoint(UpdateResolverEndpointRequest request)
Updates the name of an inbound or an outbound resolver endpoint.
|
UpdateResolverRuleResult |
updateResolverRule(UpdateResolverRuleRequest request)
Updates settings for a specified resolver rule.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonRoute53ResolverClientBuilder builder()
public AssociateResolverEndpointIpAddressResult associateResolverEndpointIpAddress(AssociateResolverEndpointIpAddressRequest request)
Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address,
submit one AssociateResolverEndpointIpAddress
request for each IP address.
To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.
associateResolverEndpointIpAddress
in interface AmazonRoute53Resolver
associateResolverEndpointIpAddressRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InvalidRequestException
- The request is invalid.ResourceExistsException
- The resource that you tried to create already exists.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.LimitExceededException
- The request caused one or more limits to be exceeded.ThrottlingException
- The request was throttled. Try again in a few minutes.public AssociateResolverRuleResult associateResolverRule(AssociateResolverRuleRequest request)
Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule.
associateResolverRule
in interface AmazonRoute53Resolver
associateResolverRuleRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidRequestException
- The request is invalid.InvalidParameterException
- One or more parameters in this request are not valid.ResourceUnavailableException
- The specified resource isn't available.ResourceExistsException
- The resource that you tried to create already exists.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public CreateResolverEndpointResult createResolverEndpoint(CreateResolverEndpointRequest request)
Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound:
An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC from your network or another VPC.
An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC to your network or another VPC.
createResolverEndpoint
in interface AmazonRoute53Resolver
createResolverEndpointRequest
- InvalidParameterException
- One or more parameters in this request are not valid.ResourceNotFoundException
- The specified resource doesn't exist.InvalidRequestException
- The request is invalid.ResourceExistsException
- The resource that you tried to create already exists.LimitExceededException
- The request caused one or more limits to be exceeded.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public CreateResolverRuleResult createResolverRule(CreateResolverRuleRequest request)
For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.
createResolverRule
in interface AmazonRoute53Resolver
createResolverRuleRequest
- InvalidParameterException
- One or more parameters in this request are not valid.InvalidRequestException
- The request is invalid.LimitExceededException
- The request caused one or more limits to be exceeded.ResourceNotFoundException
- The specified resource doesn't exist.ResourceExistsException
- The resource that you tried to create already exists.ResourceUnavailableException
- The specified resource isn't available.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public DeleteResolverEndpointResult deleteResolverEndpoint(DeleteResolverEndpointRequest request)
Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound resolver endpoint:
Inbound: DNS queries from your network or another VPC are no longer routed to the DNS service for the specified VPC.
Outbound: DNS queries from a VPC are no longer routed to your network or to another VPC.
deleteResolverEndpoint
in interface AmazonRoute53Resolver
deleteResolverEndpointRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InvalidRequestException
- The request is invalid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public DeleteResolverRuleResult deleteResolverRule(DeleteResolverRuleRequest request)
Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you associated the resolver rule with. For more infomation, see DisassociateResolverRule.
deleteResolverRule
in interface AmazonRoute53Resolver
deleteResolverRuleRequest
- InvalidParameterException
- One or more parameters in this request are not valid.ResourceNotFoundException
- The specified resource doesn't exist.ResourceInUseException
- The resource that you tried to update or delete is currently in use.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public DisassociateResolverEndpointIpAddressResult disassociateResolverEndpointIpAddress(DisassociateResolverEndpointIpAddressRequest request)
Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP
address, submit one DisassociateResolverEndpointIpAddress
request for each IP address.
To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.
disassociateResolverEndpointIpAddress
in interface AmazonRoute53Resolver
disassociateResolverEndpointIpAddressRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InvalidRequestException
- The request is invalid.ResourceExistsException
- The resource that you tried to create already exists.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public DisassociateResolverRuleResult disassociateResolverRule(DisassociateResolverRuleRequest request)
Removes the association between a specified resolver rule and a specified VPC.
If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the resolver rule.
disassociateResolverRule
in interface AmazonRoute53Resolver
disassociateResolverRuleRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public GetResolverEndpointResult getResolverEndpoint(GetResolverEndpointRequest request)
Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint.
getResolverEndpoint
in interface AmazonRoute53Resolver
getResolverEndpointRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public GetResolverRuleResult getResolverRule(GetResolverRuleRequest request)
Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with.
getResolverRule
in interface AmazonRoute53Resolver
getResolverRuleRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public GetResolverRuleAssociationResult getResolverRuleAssociation(GetResolverRuleAssociationRequest request)
Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule.
getResolverRuleAssociation
in interface AmazonRoute53Resolver
getResolverRuleAssociationRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public GetResolverRulePolicyResult getResolverRulePolicy(GetResolverRulePolicyRequest request)
Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
getResolverRulePolicy
in interface AmazonRoute53Resolver
getResolverRulePolicyRequest
- InvalidParameterException
- One or more parameters in this request are not valid.UnknownResourceException
- The specified resource doesn't exist.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.public ListResolverEndpointIpAddressesResult listResolverEndpointIpAddresses(ListResolverEndpointIpAddressesRequest request)
Gets the IP addresses for a specified resolver endpoint.
listResolverEndpointIpAddresses
in interface AmazonRoute53Resolver
listResolverEndpointIpAddressesRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.InvalidNextTokenException
- The value that you specified for NextToken
in a List
request isn't valid.ThrottlingException
- The request was throttled. Try again in a few minutes.public ListResolverEndpointsResult listResolverEndpoints(ListResolverEndpointsRequest request)
Lists all the resolver endpoints that were created using the current AWS account.
listResolverEndpoints
in interface AmazonRoute53Resolver
listResolverEndpointsRequest
- InvalidNextTokenException
- The value that you specified for NextToken
in a List
request isn't valid.InvalidRequestException
- The request is invalid.InvalidParameterException
- One or more parameters in this request are not valid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public ListResolverRuleAssociationsResult listResolverRuleAssociations(ListResolverRuleAssociationsRequest request)
Lists the associations that were created between resolver rules and VPCs using the current AWS account.
listResolverRuleAssociations
in interface AmazonRoute53Resolver
listResolverRuleAssociationsRequest
- InvalidNextTokenException
- The value that you specified for NextToken
in a List
request isn't valid.InvalidRequestException
- The request is invalid.InvalidParameterException
- One or more parameters in this request are not valid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public ListResolverRulesResult listResolverRules(ListResolverRulesRequest request)
Lists the resolver rules that were created using the current AWS account.
listResolverRules
in interface AmazonRoute53Resolver
listResolverRulesRequest
- InvalidNextTokenException
- The value that you specified for NextToken
in a List
request isn't valid.InvalidRequestException
- The request is invalid.InvalidParameterException
- One or more parameters in this request are not valid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags that you associated with the specified resource.
listTagsForResource
in interface AmazonRoute53Resolver
listTagsForResourceRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InvalidNextTokenException
- The value that you specified for NextToken
in a List
request isn't valid.InvalidRequestException
- The request is invalid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public PutResolverRulePolicyResult putResolverRulePolicy(PutResolverRulePolicyRequest request)
Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
putResolverRulePolicy
in interface AmazonRoute53Resolver
putResolverRulePolicyRequest
- InvalidPolicyDocumentException
- The specified resolver rule policy is invalid.InvalidParameterException
- One or more parameters in this request are not valid.UnknownResourceException
- The specified resource doesn't exist.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.public TagResourceResult tagResource(TagResourceRequest request)
Adds one or more tags to a specified resource.
tagResource
in interface AmazonRoute53Resolver
tagResourceRequest
- LimitExceededException
- The request caused one or more limits to be exceeded.ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InvalidTagException
- The specified tag is invalid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from a specified resource.
untagResource
in interface AmazonRoute53Resolver
untagResourceRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public UpdateResolverEndpointResult updateResolverEndpoint(UpdateResolverEndpointRequest request)
Updates the name of an inbound or an outbound resolver endpoint.
updateResolverEndpoint
in interface AmazonRoute53Resolver
updateResolverEndpointRequest
- ResourceNotFoundException
- The specified resource doesn't exist.InvalidParameterException
- One or more parameters in this request are not valid.InvalidRequestException
- The request is invalid.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public UpdateResolverRuleResult updateResolverRule(UpdateResolverRuleRequest request)
Updates settings for a specified resolver rule. ResolverRuleId
is required, and all other parameters
are optional. If you don't specify a parameter, it retains its current value.
updateResolverRule
in interface AmazonRoute53Resolver
updateResolverRuleRequest
- InvalidRequestException
- The request is invalid.InvalidParameterException
- One or more parameters in this request are not valid.ResourceNotFoundException
- The specified resource doesn't exist.ResourceUnavailableException
- The specified resource isn't available.LimitExceededException
- The request caused one or more limits to be exceeded.InternalServiceErrorException
- We encountered an unknown error. Try again in a few minutes.ThrottlingException
- The request was throttled. Try again in a few minutes.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonRoute53Resolver
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.