com.amazonaws.services.route53resolver

Interface AmazonRoute53Resolver

All Known Subinterfaces:

AmazonRoute53ResolverAsync

All Known Implementing Classes:

AbstractAmazonRoute53Resolver, AbstractAmazonRoute53ResolverAsync, AmazonRoute53ResolverAsyncClient, AmazonRoute53ResolverClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonRoute53Resolver

Interface for accessing Route53Resolver.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonRoute53Resolver instead.

Here's how you set up to query an Amazon Route 53 private hosted zone from your network:

1. Connect your network to a VPC using AWS Direct Connect or a VPN.

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

3. Get the IP addresses for the Resolver endpoints:

   get-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]

4. 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]

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateResolverEndpointIpAddressResult	associateResolverEndpointIpAddress(AssociateResolverEndpointIpAddressRequest associateResolverEndpointIpAddressRequest) Adds IP addresses to an inbound or an outbound resolver endpoint.
AssociateResolverRuleResult	associateResolverRule(AssociateResolverRuleRequest associateResolverRuleRequest) Associates a resolver rule with a VPC.
CreateResolverEndpointResult	createResolverEndpoint(CreateResolverEndpointRequest createResolverEndpointRequest) Creates a resolver endpoint.
CreateResolverRuleResult	createResolverRule(CreateResolverRuleRequest createResolverRuleRequest) 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 deleteResolverEndpointRequest) Deletes a resolver endpoint.
DeleteResolverRuleResult	deleteResolverRule(DeleteResolverRuleRequest deleteResolverRuleRequest) Deletes a resolver rule.
DisassociateResolverEndpointIpAddressResult	disassociateResolverEndpointIpAddress(DisassociateResolverEndpointIpAddressRequest disassociateResolverEndpointIpAddressRequest) Removes IP addresses from an inbound or an outbound resolver endpoint.
DisassociateResolverRuleResult	disassociateResolverRule(DisassociateResolverRuleRequest disassociateResolverRuleRequest) 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 getResolverEndpointRequest) 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 getResolverRuleRequest) 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 getResolverRuleAssociationRequest) Gets information about an association between a specified resolver rule and a VPC.
GetResolverRulePolicyResult	getResolverRulePolicy(GetResolverRulePolicyRequest getResolverRulePolicyRequest) Gets information about a resolver rule policy.
ListResolverEndpointIpAddressesResult	listResolverEndpointIpAddresses(ListResolverEndpointIpAddressesRequest listResolverEndpointIpAddressesRequest) Gets the IP addresses for a specified resolver endpoint.
ListResolverEndpointsResult	listResolverEndpoints(ListResolverEndpointsRequest listResolverEndpointsRequest) Lists all the resolver endpoints that were created using the current AWS account.
ListResolverRuleAssociationsResult	listResolverRuleAssociations(ListResolverRuleAssociationsRequest listResolverRuleAssociationsRequest) Lists the associations that were created between resolver rules and VPCs using the current AWS account.
ListResolverRulesResult	listResolverRules(ListResolverRulesRequest listResolverRulesRequest) Lists the resolver rules that were created using the current AWS account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that you associated with the specified resource.
PutResolverRulePolicyResult	putResolverRulePolicy(PutResolverRulePolicyRequest putResolverRulePolicyRequest) Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to a specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from a specified resource.
UpdateResolverEndpointResult	updateResolverEndpoint(UpdateResolverEndpointRequest updateResolverEndpointRequest) Updates the name of an inbound or an outbound resolver endpoint.
UpdateResolverRuleResult	updateResolverRule(UpdateResolverRuleRequest updateResolverRuleRequest) Updates settings for a specified resolver rule.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateResolverEndpointIpAddress

AssociateResolverEndpointIpAddressResult associateResolverEndpointIpAddress(AssociateResolverEndpointIpAddressRequest associateResolverEndpointIpAddressRequest)

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.

Parameters:

associateResolverEndpointIpAddressRequest -

Returns:

Result of the AssociateResolverEndpointIpAddress operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

associateResolverRule

AssociateResolverRuleResult associateResolverRule(AssociateResolverRuleRequest associateResolverRuleRequest)

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.

Parameters:

associateResolverRuleRequest -

Returns:

Result of the AssociateResolverRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createResolverEndpoint

CreateResolverEndpointResult createResolverEndpoint(CreateResolverEndpointRequest createResolverEndpointRequest)

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.

Parameters:

createResolverEndpointRequest -

Returns:

Result of the CreateResolverEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createResolverRule

CreateResolverRuleResult createResolverRule(CreateResolverRuleRequest createResolverRuleRequest)

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.

Parameters:

createResolverRuleRequest -

Returns:

Result of the CreateResolverRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteResolverEndpoint

DeleteResolverEndpointResult deleteResolverEndpoint(DeleteResolverEndpointRequest deleteResolverEndpointRequest)

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.

Parameters:

deleteResolverEndpointRequest -

Returns:

Result of the DeleteResolverEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteResolverRule

DeleteResolverRuleResult deleteResolverRule(DeleteResolverRuleRequest deleteResolverRuleRequest)

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.

Parameters:

deleteResolverRuleRequest -

Returns:

Result of the DeleteResolverRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disassociateResolverEndpointIpAddress

DisassociateResolverEndpointIpAddressResult disassociateResolverEndpointIpAddress(DisassociateResolverEndpointIpAddressRequest disassociateResolverEndpointIpAddressRequest)

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.

Parameters:

disassociateResolverEndpointIpAddressRequest -

Returns:

Result of the DisassociateResolverEndpointIpAddress operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disassociateResolverRule

DisassociateResolverRuleResult disassociateResolverRule(DisassociateResolverRuleRequest disassociateResolverRuleRequest)

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.

Parameters:

disassociateResolverRuleRequest -

Returns:

Result of the DisassociateResolverRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getResolverEndpoint

GetResolverEndpointResult getResolverEndpoint(GetResolverEndpointRequest getResolverEndpointRequest)

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.

Parameters:

getResolverEndpointRequest -

Returns:

Result of the GetResolverEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getResolverRule

GetResolverRuleResult getResolverRule(GetResolverRuleRequest getResolverRuleRequest)

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.

Parameters:

getResolverRuleRequest -

Returns:

Result of the GetResolverRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getResolverRuleAssociation

GetResolverRuleAssociationResult getResolverRuleAssociation(GetResolverRuleAssociationRequest getResolverRuleAssociationRequest)

Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule.

Parameters:

getResolverRuleAssociationRequest -

Returns:

Result of the GetResolverRuleAssociation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getResolverRulePolicy

GetResolverRulePolicyResult getResolverRulePolicy(GetResolverRulePolicyRequest getResolverRulePolicyRequest)

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.

Parameters:

getResolverRulePolicyRequest -

Returns:

Result of the GetResolverRulePolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listResolverEndpointIpAddresses

ListResolverEndpointIpAddressesResult listResolverEndpointIpAddresses(ListResolverEndpointIpAddressesRequest listResolverEndpointIpAddressesRequest)

Gets the IP addresses for a specified resolver endpoint.

Parameters:

listResolverEndpointIpAddressesRequest -

Returns:

Result of the ListResolverEndpointIpAddresses operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listResolverEndpoints

ListResolverEndpointsResult listResolverEndpoints(ListResolverEndpointsRequest listResolverEndpointsRequest)

Lists all the resolver endpoints that were created using the current AWS account.

Parameters:

listResolverEndpointsRequest -

Returns:

Result of the ListResolverEndpoints operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listResolverRuleAssociations

ListResolverRuleAssociationsResult listResolverRuleAssociations(ListResolverRuleAssociationsRequest listResolverRuleAssociationsRequest)

Lists the associations that were created between resolver rules and VPCs using the current AWS account.

Parameters:

listResolverRuleAssociationsRequest -

Returns:

Result of the ListResolverRuleAssociations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listResolverRules

ListResolverRulesResult listResolverRules(ListResolverRulesRequest listResolverRulesRequest)

Lists the resolver rules that were created using the current AWS account.

Parameters:

listResolverRulesRequest -

Returns:

Result of the ListResolverRules operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags that you associated with the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putResolverRulePolicy

PutResolverRulePolicyResult putResolverRulePolicy(PutResolverRulePolicyRequest putResolverRulePolicyRequest)

Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.

Parameters:

putResolverRulePolicyRequest -

Returns:

Result of the PutResolverRulePolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds one or more tags to a specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags from a specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateResolverEndpoint

UpdateResolverEndpointResult updateResolverEndpoint(UpdateResolverEndpointRequest updateResolverEndpointRequest)

Updates the name of an inbound or an outbound resolver endpoint.

Parameters:

updateResolverEndpointRequest -

Returns:

Result of the UpdateResolverEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateResolverRule

UpdateResolverRuleResult updateResolverRule(UpdateResolverRuleRequest updateResolverRuleRequest)

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.

Parameters:

updateResolverRuleRequest -

Returns:

Result of the UpdateResolverRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.