openapi: 3.0.0 info: version: '2018-04-01' x-release: v4 title: 'Amazon Route 53 Resolver #X Amz Target=Route53Resolver.AssociateFirewallRuleGroup #X Amz Target=Route53Resolver.AssociateFirewallRuleGroup #X Amz Target=Route53Resolver.ListResolverEndpoints API' description:

When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names such as domain names for EC2 instances or Elastic Load Balancing load balancers. Resolver performs recursive lookups against public name servers for all other domain names.

You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:

Forward DNS queries from resolvers on your network to Route 53 Resolver

DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers to easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone. For more information, see How DNS Resolvers on Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.

Conditionally forward queries from a VPC to resolvers on your network

You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward (such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match (acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see How Route 53 Resolver Forwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.

Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose whether to forward queries from your VPCs to your network (outbound queries), from your network to your VPCs (inbound queries), or both.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: route53resolver x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/route53resolver-2018-04-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://route53resolver.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Route53Resolver multi-region endpoint - url: https://route53resolver.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Route53Resolver multi-region endpoint - url: http://route53resolver.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Route53Resolver endpoint for China (Beijing) and China (Ningxia) - url: https://route53resolver.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Route53Resolver endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=Route53Resolver.ListResolverEndpoints' paths: /#X-Amz-Target=Route53Resolver.ListResolverEndpoints: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListResolverEndpoints description: Lists all the Resolver endpoints that were created using the current Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListResolverEndpointsResponse' '480': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' '481': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListResolverEndpointsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.ListResolverEndpoints tags: - '#X Amz Target=Route53Resolver.ListResolverEndpoints' components: schemas: ResolverEndpoint: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceId' - description: The ID of the Resolver endpoint. CreatorRequestId: allOf: - $ref: '#/components/schemas/CreatorRequestId' - description: A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice. Arn: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN (Amazon Resource Name) for the Resolver endpoint. Name: allOf: - $ref: '#/components/schemas/Name' - description: The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request. SecurityGroupIds: allOf: - $ref: '#/components/schemas/SecurityGroupIds' - description: The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network. Direction: allOf: - $ref: '#/components/schemas/ResolverEndpointDirection' - description: '

Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

' IpAddressCount: allOf: - $ref: '#/components/schemas/IpAddressCount' - description: The number of IP addresses that the Resolver endpoint can use for DNS queries. HostVPCId: allOf: - $ref: '#/components/schemas/ResourceId' - description: The ID of the VPC that you want to create the Resolver endpoint in. Status: allOf: - $ref: '#/components/schemas/ResolverEndpointStatus' - description: '

A code that specifies the current status of the Resolver endpoint. Valid values include the following:

' StatusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: A detailed description of the status of the Resolver endpoint. CreationTime: allOf: - $ref: '#/components/schemas/Rfc3339TimeString' - description: The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC). ModificationTime: allOf: - $ref: '#/components/schemas/Rfc3339TimeString' - description: The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC). ResolverEndpointType: allOf: - $ref: '#/components/schemas/ResolverEndpointType' - description: ' The Resolver endpoint IP address type. ' description: In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, Updates the name, or ResolverEndpointType for an endpoint, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint. ResolverEndpointType: type: string enum: - IPV6 - IPV4 - DUALSTACK Filter: type: object properties: Name: allOf: - $ref: '#/components/schemas/FilterName' - description: '

The name of the parameter that you want to use to filter objects.

The valid values for Name depend on the action that you''re including the filter in, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, or ListResolverQueryLogConfigAssociations.

In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, CreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.

ListResolverEndpoints

Valid values for Name include the following:

ListResolverRules

Valid values for Name include the following:

ListResolverRuleAssociations

Valid values for Name include the following:

ListResolverQueryLogConfigs

Valid values for Name include the following:

ListResolverQueryLogConfigAssociations

Valid values for Name include the following:

' Values: allOf: - $ref: '#/components/schemas/FilterValues' - description: When you're using a List operation and you want the operation to return a subset of objects, such as Resolver endpoints or Resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values. description:

For Resolver list operations (ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, ListResolverQueryLogConfigAssociations), and ListResolverDnssecConfigs), an optional specification to return a subset of objects.

To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.

Arn: type: string minLength: 1 maxLength: 255 ThrottlingException: {} InvalidParameterException: {} InvalidRequestException: {} ResourceId: type: string minLength: 1 maxLength: 64 ResolverEndpointStatus: type: string enum: - CREATING - OPERATIONAL - UPDATING - AUTO_RECOVERING - ACTION_NEEDED - DELETING InternalServiceErrorException: {} MaxResults: type: integer minimum: 1 maximum: 100 FilterValue: type: string minLength: 1 maxLength: 600 FilterName: type: string minLength: 1 maxLength: 64 StatusMessage: type: string maxLength: 255 NextToken: type: string FilterValues: type: array items: $ref: '#/components/schemas/FilterValue' InvalidNextTokenException: {} SecurityGroupIds: type: array items: $ref: '#/components/schemas/ResourceId' ListResolverEndpointsResponse: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response. ' MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: The value that you specified for MaxResults in the request. ResolverEndpoints: allOf: - $ref: '#/components/schemas/ResolverEndpoints' - description: The Resolver endpoints that were created by using the current Amazon Web Services account, and that match the specified filters, if any. Name: type: string pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+) maxLength: 64 ResolverEndpointDirection: type: string enum: - INBOUND - OUTBOUND IpAddressCount: type: integer Rfc3339TimeString: type: string minLength: 20 maxLength: 40 CreatorRequestId: type: string minLength: 1 maxLength: 255 ListResolverEndpointsRequest: type: object title: ListResolverEndpointsRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'The maximum number of Resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don''t specify a value for MaxResults, Resolver returns up to 100 Resolver endpoints. ' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description:

For the first ListResolverEndpoints request, omit this value.

If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.

Filters: allOf: - $ref: '#/components/schemas/Filters' - description:

An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.

If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

Filters: type: array items: $ref: '#/components/schemas/Filter' ResolverEndpoints: type: array items: $ref: '#/components/schemas/ResolverEndpoint' parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/route53resolver/ x-hasEquivalentPaths: true