Amazon Route 53
API Reference

AssociateResolverRule

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.

Request Syntax

{ "Name": "string", "ResolverRuleId": "string", "VPCId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

A name for the association that you're creating between a resolver rule and a VPC.

Type: String

Length Constraints: Maximum length of 64.

Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_' ']+)

Required: No

ResolverRuleId

The ID of the resolver rule that you want to associate with the VPC. To list the existing resolver rules, use ListResolverRules.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

VPCId

The ID of the VPC that you want to associate the resolver rule with.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

Response Syntax

{ "ResolverRuleAssociation": { "Id": "string", "Name": "string", "ResolverRuleId": "string", "Status": "string", "StatusMessage": "string", "VPCId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ResolverRuleAssociation

Information about the AssociateResolverRule request, including the status of the request.

Type: ResolverRuleAssociation object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceErrorException

We encountered an unknown error. Try again in a few minutes.

HTTP Status Code: 400

InvalidParameterException

One or more parameters in this request are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is invalid.

HTTP Status Code: 400

ResourceExistsException

The resource that you tried to create already exists.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 400

ResourceUnavailableException

The specified resource isn't available.

HTTP Status Code: 400

ThrottlingException

The request was throttled. Try again in a few minutes.

HTTP Status Code: 400

Example

AssociateResolverRule Example

Sample Request

POST / HTTP/1.1 Host: route53resolver.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 82 X-Amz-Target: Route53Resolver.AssociateResolverRule X-Amz-Date: 20181101T192826Z User-Agent: aws-cli/1.16.45 Python/2.7.10 Darwin/16.7.0 botocore/1.12.35 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAJJ2SONIPEXAMPLE/20181101/us-east-2/route53resolver/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=[calculated-signature] { "VPCId": "vpc-03cf94c75cexample", "ResolverRuleId": "rslvr-rr-5328a0899aexample" }

Sample Response

HTTP/1.1 200 OK Date: Thu, 01 Nov 2018 19:28:27 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 258 x-amzn-RequestId: 9827eb40-87e6-44d6-bee7-a1116example Connection: keep-alive { "ResolverRuleAssociation":{ "Id":"rslvr-rrassoc-97242eaf88example", "Name":"forward example.com for gamma VPC", "ResolverRuleId":"rslvr-rr-5328a0899example", "Status":"CREATING", "StatusMessage":"[Trace id: 1-5bdb53db-75f3852c8384ad30fexample], Creating the association.", "VPCId":"vpc-03cf94c75cexample" } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: