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.CreateResolverEndpoint 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.CreateResolverEndpoint' paths: /#X-Amz-Target=Route53Resolver.CreateResolverEndpoint: 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: CreateResolverEndpoint description: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.
An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC to your network.
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:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can''t automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn''t available, add another IP address and then delete the IP address that isn''t available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn''t be created for some reason that''s outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
CreatorRequestId can be any unique string, for example, a date/time stamp. '
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIds'
- description: The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver 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: 'Specify the applicable value:
INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network
OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network
IpAddressRequest also includes the ID of the subnet that contains the IP address.
Tag:
type: object
required:
- Key
- Value
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.
description: One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value.
CreateResolverEndpointResponse:
type: object
properties:
ResolverEndpoint:
allOf:
- $ref: '#/components/schemas/ResolverEndpoint'
- description: Information about the CreateResolverEndpoint request, including the status of the request.
TagValue:
type: string
minLength: 0
maxLength: 256
Name:
type: string
pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)
maxLength: 64
ResolverEndpointDirection:
type: string
enum:
- INBOUND
- OUTBOUND
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
maxItems: 200
IpAddressCount:
type: integer
Rfc3339TimeString:
type: string
minLength: 20
maxLength: 40
CreatorRequestId:
type: string
minLength: 1
maxLength: 255
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