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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/route53resolver/ 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) x-hasEquivalentPaths: true paths: /#X-Amz-Target=Route53Resolver.AssociateFirewallRuleGroup: post: operationId: AssociateFirewallRuleGroup description: 'Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateFirewallRuleGroupResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssociateFirewallRuleGroupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.AssociateFirewallRuleGroup 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' /#X-Amz-Target=Route53Resolver.AssociateResolverEndpointIpAddress: post: operationId: AssociateResolverEndpointIpAddress description:Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one AssociateResolverEndpointIpAddress request
for each IP address.
To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateResolverEndpointIpAddressResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '483': description: ResourceExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceExistsException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '485': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssociateResolverEndpointIpAddressRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.AssociateResolverEndpointIpAddress 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' /#X-Amz-Target=Route53Resolver.AssociateResolverQueryLogConfig: post: operationId: AssociateResolverQueryLogConfig description:Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a
specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig request for each VPC.
The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.
To remove a VPC from a query logging configuration, see DisassociateResolverQueryLogConfig.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateResolverQueryLogConfigResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '483': description: ResourceExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceExistsException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssociateResolverQueryLogConfigRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.AssociateResolverQueryLogConfig 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' /#X-Amz-Target=Route53Resolver.AssociateResolverRule: post: operationId: AssociateResolverRule description: '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. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateResolverRuleResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '484': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' '485': description: ResourceExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceExistsException' '486': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssociateResolverRuleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.AssociateResolverRule 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' /#X-Amz-Target=Route53Resolver.CreateFirewallDomainList: post: operationId: CreateFirewallDomainList description: 'Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateFirewallDomainListResponse' '480': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '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/CreateFirewallDomainListRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.CreateFirewallDomainList 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' /#X-Amz-Target=Route53Resolver.CreateFirewallRule: post: operationId: CreateFirewallRule description: Creates a single DNS Firewall rule in the specified rule group, using the specified domain list. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateFirewallRuleResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFirewallRuleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.CreateFirewallRule 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' /#X-Amz-Target=Route53Resolver.CreateFirewallRuleGroup: post: operationId: CreateFirewallRuleGroup description: 'Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling CreateFirewallRule. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateFirewallRuleGroupResponse' '480': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '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/CreateFirewallRuleGroupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.CreateFirewallRuleGroup 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' /#X-Amz-Target=Route53Resolver.CreateResolverEndpoint: 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.
Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.
To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more
information, see AssociateResolverQueryLogConfig.
You can optionally use Resource Access Manager (RAM) to share a query logging configuration with other Amazon Web Services accounts. The other accounts can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all VPCs that are associated with the configuration.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateResolverQueryLogConfigResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '483': description: ResourceExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceExistsException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateResolverQueryLogConfigRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.CreateResolverQueryLogConfig 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' /#X-Amz-Target=Route53Resolver.CreateResolverRule: post: operationId: CreateResolverRule description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateResolverRuleResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ResourceExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceExistsException' '485': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' '486': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateResolverRuleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.CreateResolverRule 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' /#X-Amz-Target=Route53Resolver.DeleteFirewallDomainList: post: operationId: DeleteFirewallDomainList description: 'Deletes the specified domain list. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteFirewallDomainListResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '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/DeleteFirewallDomainListRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.DeleteFirewallDomainList 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' /#X-Amz-Target=Route53Resolver.DeleteFirewallRule: post: operationId: DeleteFirewallRule description: Deletes the specified firewall rule. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteFirewallRuleResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteFirewallRuleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.DeleteFirewallRule 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' /#X-Amz-Target=Route53Resolver.DeleteFirewallRuleGroup: post: operationId: DeleteFirewallRuleGroup description: 'Deletes the specified firewall rule group. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteFirewallRuleGroupResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteFirewallRuleGroupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.DeleteFirewallRuleGroup 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' /#X-Amz-Target=Route53Resolver.DeleteResolverEndpoint: post: operationId: DeleteResolverEndpoint description: "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 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.
Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other Amazon Web Services accounts, and the other accounts have associated VPCs with the shared configuration.
Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig.
If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs that they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically disassociated from the configuration.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteResolverQueryLogConfigResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteResolverQueryLogConfigRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.DeleteResolverQueryLogConfig 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' /#X-Amz-Target=Route53Resolver.DeleteResolverRule: post: operationId: DeleteResolverRule description: 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 information, see DisassociateResolverRule. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteResolverRuleResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '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/DeleteResolverRuleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.DeleteResolverRule 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' /#X-Amz-Target=Route53Resolver.DisassociateFirewallRuleGroup: post: operationId: DisassociateFirewallRuleGroup description: 'Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisassociateFirewallRuleGroupResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisassociateFirewallRuleGroupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.DisassociateFirewallRuleGroup 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' /#X-Amz-Target=Route53Resolver.DisassociateResolverEndpointIpAddress: post: operationId: DisassociateResolverEndpointIpAddress description: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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisassociateResolverEndpointIpAddressResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '483': description: ResourceExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceExistsException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisassociateResolverEndpointIpAddressRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Route53Resolver.DisassociateResolverEndpointIpAddress 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' /#X-Amz-Target=Route53Resolver.DisassociateResolverQueryLogConfig: post: operationId: DisassociateResolverQueryLogConfig description:Disassociates a VPC from a query logging configuration.
Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration in the following ways:
The accounts that you shared the configuration with can disassociate VPCs from the configuration.
You can stop sharing the configuration.
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.
Imports domain names from a file into a domain list, for use in a DNS firewall rule group.
Each domain specification in your domain list must satisfy the following requirements:
It can optionally start with * (asterisk).
With the exception of the optional starting asterisk, it must only contain the following characters: A-Z,
a-z, 0-9, - (hyphen).
It must be from 1-255 characters in length.
Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs.
A single call might return
only a partial list of the configurations. For information, see MaxResults.
Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling ListFirewallDomains.
A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults.
Retrieves the domains that you have defined for the specified firewall domain list.
A single call might return only a partial list of the domains. For information, see
MaxResults.
Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group.
A single call might return
only a partial list of the associations. For information, see MaxResults.
Retrieves the minimal high-level information for the rule groups that you have defined.
A single call might return only a partial list of the rule groups. For
information, see MaxResults.
Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.
A single call might return only a partial list of the rules. For information, see MaxResults.
ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its
current value.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverRuleResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UpdateResolverRule
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'
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
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-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
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
schemas:
AssociateFirewallRuleGroupResponse:
type: object
properties:
FirewallRuleGroupAssociation:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupAssociation'
- description: The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.
AssociateFirewallRuleGroupRequest:
type: object
required:
- CreatorRequestId
- FirewallRuleGroupId
- VpcId
- Priority
- Name
title: AssociateFirewallRuleGroupRequest
properties:
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be
any unique string, for example, a date/time stamp. '
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group. '
VpcId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the VPC that you want to associate with the rule group. '
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.
You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on. You can change the priority setting for a rule group association after you create it.
The allowed values for Priority are between 100 and 9900.
DISABLED. '
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'A list of the tag keys and values that you want to associate with the rule group association. '
ResourceNotFoundException: {}
ValidationException: {}
LimitExceededException: {}
ConflictException: {}
AccessDeniedException: {}
InternalServiceErrorException: {}
ThrottlingException: {}
AssociateResolverEndpointIpAddressResponse:
type: object
properties:
ResolverEndpoint:
allOf:
- $ref: '#/components/schemas/ResolverEndpoint'
- description: The response to an AssociateResolverEndpointIpAddress request.
AssociateResolverEndpointIpAddressRequest:
type: object
required:
- ResolverEndpointId
- IpAddress
title: AssociateResolverEndpointIpAddressRequest
properties:
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver endpoint that you want to associate IP addresses with.
IpAddress:
allOf:
- $ref: '#/components/schemas/IpAddressUpdate'
- description: Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs
in the specified subnet.
InvalidParameterException: {}
InvalidRequestException: {}
ResourceExistsException: {}
AssociateResolverQueryLogConfigResponse:
type: object
properties:
ResolverQueryLogConfigAssociation:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigAssociation'
- description: A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.
AssociateResolverQueryLogConfigRequest:
type: object
required:
- ResolverQueryLogConfigId
- ResourceId
title: AssociateResolverQueryLogConfigRequest
properties:
ResolverQueryLogConfigId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the query logging configuration that you want to associate a VPC with.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of an Amazon VPC that you want this query logging configuration to log queries for.
The VPCs and the query logging configuration must be in the same Region.
AssociateResolverRule request, including the status of the request.
AssociateResolverRuleRequest:
type: object
required:
- ResolverRuleId
- VPCId
title: AssociateResolverRuleRequest
properties:
ResolverRuleId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule that you want to associate with the VPC. To list the existing Resolver rules, use ListResolverRules.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: A name for the association that you're creating between a Resolver rule and a VPC.
VPCId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the VPC that you want to associate the Resolver rule with.
ResourceUnavailableException: {}
CreateFirewallDomainListResponse:
type: object
properties:
FirewallDomainList:
allOf:
- $ref: '#/components/schemas/FirewallDomainList'
- description: The domain list that you just created.
CreateFirewallDomainListRequest:
type: object
required:
- CreatorRequestId
- Name
title: CreateFirewallDomainListRequest
properties:
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any
unique string, for example, a date/time stamp. '
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: A name that lets you identify the domain list to manage and use it.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'A list of the tag keys and values that you want to associate with the domain list. '
CreateFirewallRuleResponse:
type: object
properties:
FirewallRule:
allOf:
- $ref: '#/components/schemas/FirewallRule'
- description: 'The firewall rule that you just created. '
CreateFirewallRuleRequest:
type: object
required:
- CreatorRequestId
- FirewallRuleGroupId
- FirewallDomainListId
- Priority
- Action
- Name
title: CreateFirewallRuleRequest
properties:
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any
unique string, for example, a date/time stamp. '
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group where you want to create the rule. '
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list that you want to use in the rule. '
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
Action: allOf: - $ref: '#/components/schemas/Action' - description:The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the
request to go through.
ALERT - Permit the request and send metrics and logs to Cloud Watch.
BLOCK - Disallow the request.
This option requires additional details in the rule's BlockResponse.
The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.
NODATA - Respond indicating
that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't
exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride*
settings.
This setting is required if the rule action setting is BLOCK.
The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of
OVERRIDE.
This setting is required if the BlockResponse setting is OVERRIDE.
The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK
with a BlockResponse setting of OVERRIDE.
This setting is required if the BlockResponse setting is OVERRIDE.
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
This setting is required if the BlockResponse setting is OVERRIDE.
CreateResolverEndpoint request, including the status of the request.
CreateResolverEndpointRequest:
type: object
required:
- CreatorRequestId
- SecurityGroupIds
- Direction
- IpAddresses
title: CreateResolverEndpointRequest
properties:
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. 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
CreateResolverQueryLogConfig request, including the status of the request.
CreateResolverQueryLogConfigRequest:
type: object
required:
- Name
- DestinationArn
- CreatorRequestId
title: CreateResolverQueryLogConfigRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigName'
- description: The name that you want to give the query logging configuration.
DestinationArn:
allOf:
- $ref: '#/components/schemas/DestinationArn'
- description: 'The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:
S3 bucket:
arn:aws:s3:::examplebucket
You can optionally append a file prefix to the end of the ARN.
arn:aws:s3:::examplebucket/development/
CloudWatch Logs log group:
arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*
Kinesis Data Firehose delivery stream:
arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name
CreatorRequestId can be
any unique string, for example, a date/time stamp. '
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: A list of the tag keys and values that you want to associate with the query logging configuration.
CreateResolverRuleResponse:
type: object
properties:
ResolverRule:
allOf:
- $ref: '#/components/schemas/ResolverRule'
- description: Information about the CreateResolverRule request, including the status of the request.
CreateResolverRuleRequest:
type: object
required:
- CreatorRequestId
- RuleType
- DomainName
title: CreateResolverRuleRequest
properties:
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. 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 rule in the Resolver dashboard in the Route 53 console.
RuleType:
allOf:
- $ref: '#/components/schemas/RuleTypeOption'
- description: When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.
When you have a forwarding rule to forward
DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
For example, to forward DNS queries
for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com,
you create a rule and specify SYSTEM for RuleType.
Currently, only Resolver can create rules that have a value of RECURSIVE for
RuleType.
TargetIps. If a query matches multiple Resolver rules (example.com and
www.example.com), outbound DNS queries are routed using the Resolver rule that contains the most specific domain name (www.example.com).
TargetIps:
allOf:
- $ref: '#/components/schemas/TargetList'
- description: The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a space.
TargetIps is
available only when the value of Rule type is FORWARD.
TargetIps.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: A list of the tag keys and values that you want to associate with the endpoint.
DeleteFirewallDomainListResponse:
type: object
properties:
FirewallDomainList:
allOf:
- $ref: '#/components/schemas/FirewallDomainList'
- description: 'The domain list that you just deleted. '
DeleteFirewallDomainListRequest:
type: object
required:
- FirewallDomainListId
title: DeleteFirewallDomainListRequest
properties:
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list that you want to delete. '
DeleteFirewallRuleResponse:
type: object
properties:
FirewallRule:
allOf:
- $ref: '#/components/schemas/FirewallRule'
- description: The specification for the firewall rule that you just deleted.
DeleteFirewallRuleRequest:
type: object
required:
- FirewallRuleGroupId
- FirewallDomainListId
title: DeleteFirewallRuleRequest
properties:
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group that you want to delete the rule from. '
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: "The ID of the domain list that's used in the rule. "
DeleteFirewallRuleGroupResponse:
type: object
properties:
FirewallRuleGroup:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroup'
- description: 'A collection of rules used to filter DNS network traffic. '
DeleteFirewallRuleGroupRequest:
type: object
required:
- FirewallRuleGroupId
title: DeleteFirewallRuleGroupRequest
properties:
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group that you want to delete. '
DeleteResolverEndpointResponse:
type: object
properties:
ResolverEndpoint:
allOf:
- $ref: '#/components/schemas/ResolverEndpoint'
- description: Information about the DeleteResolverEndpoint request, including the status of the request.
DeleteResolverEndpointRequest:
type: object
required:
- ResolverEndpointId
title: DeleteResolverEndpointRequest
properties:
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver endpoint that you want to delete.
DeleteResolverQueryLogConfigResponse:
type: object
properties:
ResolverQueryLogConfig:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfig'
- description: Information about the query logging configuration that you deleted, including the status of the request.
DeleteResolverQueryLogConfigRequest:
type: object
required:
- ResolverQueryLogConfigId
title: DeleteResolverQueryLogConfigRequest
properties:
ResolverQueryLogConfigId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the query logging configuration that you want to delete.
DeleteResolverRuleResponse:
type: object
properties:
ResolverRule:
allOf:
- $ref: '#/components/schemas/ResolverRule'
- description: Information about the DeleteResolverRule request, including the status of the request.
DeleteResolverRuleRequest:
type: object
required:
- ResolverRuleId
title: DeleteResolverRuleRequest
properties:
ResolverRuleId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule that you want to delete.
ResourceInUseException: {}
DisassociateFirewallRuleGroupResponse:
type: object
properties:
FirewallRuleGroupAssociation:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupAssociation'
- description: 'The firewall rule group association that you just removed. '
DisassociateFirewallRuleGroupRequest:
type: object
required:
- FirewallRuleGroupAssociationId
title: DisassociateFirewallRuleGroupRequest
properties:
FirewallRuleGroupAssociationId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The identifier of the FirewallRuleGroupAssociation. '
DisassociateResolverEndpointIpAddressResponse:
type: object
properties:
ResolverEndpoint:
allOf:
- $ref: '#/components/schemas/ResolverEndpoint'
- description: The response to an DisassociateResolverEndpointIpAddress request.
DisassociateResolverEndpointIpAddressRequest:
type: object
required:
- ResolverEndpointId
- IpAddress
title: DisassociateResolverEndpointIpAddressRequest
properties:
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver endpoint that you want to disassociate an IP address from.
IpAddress:
allOf:
- $ref: '#/components/schemas/IpAddressUpdate'
- description: The IPv4 address that you want to remove from a Resolver endpoint.
DisassociateResolverQueryLogConfigResponse:
type: object
properties:
ResolverQueryLogConfigAssociation:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigAssociation'
- description: A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.
DisassociateResolverQueryLogConfigRequest:
type: object
required:
- ResolverQueryLogConfigId
- ResourceId
title: DisassociateResolverQueryLogConfigRequest
properties:
ResolverQueryLogConfigId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the query logging configuration that you want to disassociate a specified VPC from.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.
DisassociateResolverRuleResponse:
type: object
properties:
ResolverRuleAssociation:
allOf:
- $ref: '#/components/schemas/ResolverRuleAssociation'
- description: Information about the DisassociateResolverRule request, including the status of the request.
DisassociateResolverRuleRequest:
type: object
required:
- VPCId
- ResolverRuleId
title: DisassociateResolverRuleRequest
properties:
VPCId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the VPC that you want to disassociate the Resolver rule from.
ResolverRuleId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule that you want to disassociate from the specified VPC.
GetFirewallConfigResponse:
type: object
properties:
FirewallConfig:
allOf:
- $ref: '#/components/schemas/FirewallConfig'
- description: 'Configuration of the firewall behavior provided by DNS Firewall for a single VPC from AmazonVPC. '
GetFirewallConfigRequest:
type: object
required:
- ResourceId
title: GetFirewallConfigRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the VPC from Amazon VPC that the configuration is for.
GetFirewallDomainListResponse:
type: object
properties:
FirewallDomainList:
allOf:
- $ref: '#/components/schemas/FirewallDomainList'
- description: 'The domain list that you requested. '
GetFirewallDomainListRequest:
type: object
required:
- FirewallDomainListId
title: GetFirewallDomainListRequest
properties:
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list. '
GetFirewallRuleGroupResponse:
type: object
properties:
FirewallRuleGroup:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroup'
- description: 'A collection of rules used to filter DNS network traffic. '
GetFirewallRuleGroupRequest:
type: object
required:
- FirewallRuleGroupId
title: GetFirewallRuleGroupRequest
properties:
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group. '
GetFirewallRuleGroupAssociationResponse:
type: object
properties:
FirewallRuleGroupAssociation:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupAssociation'
- description: 'The association that you requested. '
GetFirewallRuleGroupAssociationRequest:
type: object
required:
- FirewallRuleGroupAssociationId
title: GetFirewallRuleGroupAssociationRequest
properties:
FirewallRuleGroupAssociationId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The identifier of the FirewallRuleGroupAssociation. '
GetFirewallRuleGroupPolicyResponse:
type: object
properties:
FirewallRuleGroupPolicy:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupPolicy'
- description: 'The Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager
(RAM). '
GetFirewallRuleGroupPolicyRequest:
type: object
required:
- Arn
title: GetFirewallRuleGroupPolicyRequest
properties:
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The ARN (Amazon Resource Name) for the rule group.
GetResolverConfigResponse:
type: object
properties:
ResolverConfig:
allOf:
- $ref: '#/components/schemas/ResolverConfig'
- description: Information about the behavior configuration of Route 53 Resolver behavior for the VPC you specified in the GetResolverConfig request.
GetResolverConfigRequest:
type: object
required:
- ResourceId
title: GetResolverConfigRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: Resource ID of the Amazon VPC that you want to get information about.
GetResolverDnssecConfigResponse:
type: object
properties:
ResolverDNSSECConfig:
allOf:
- $ref: '#/components/schemas/ResolverDnssecConfig'
- description: The information about a configuration for DNSSEC validation.
GetResolverDnssecConfigRequest:
type: object
required:
- ResourceId
title: GetResolverDnssecConfigRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the virtual private cloud (VPC) for the DNSSEC validation status.
GetResolverEndpointResponse:
type: object
properties:
ResolverEndpoint:
allOf:
- $ref: '#/components/schemas/ResolverEndpoint'
- description: Information about the Resolver endpoint that you specified in a GetResolverEndpoint request.
GetResolverEndpointRequest:
type: object
required:
- ResolverEndpointId
title: GetResolverEndpointRequest
properties:
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver endpoint that you want to get information about.
GetResolverQueryLogConfigResponse:
type: object
properties:
ResolverQueryLogConfig:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfig'
- description: Information about the Resolver query logging configuration that you specified in a GetQueryLogConfig request.
GetResolverQueryLogConfigRequest:
type: object
required:
- ResolverQueryLogConfigId
title: GetResolverQueryLogConfigRequest
properties:
ResolverQueryLogConfigId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver query logging configuration that you want to get information about.
GetResolverQueryLogConfigAssociationResponse:
type: object
properties:
ResolverQueryLogConfigAssociation:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigAssociation'
- description: Information about the Resolver query logging configuration association that you specified in a GetQueryLogConfigAssociation request.
GetResolverQueryLogConfigAssociationRequest:
type: object
required:
- ResolverQueryLogConfigAssociationId
title: GetResolverQueryLogConfigAssociationRequest
properties:
ResolverQueryLogConfigAssociationId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver query logging configuration association that you want to get information about.
GetResolverQueryLogConfigPolicyResponse:
type: object
properties:
ResolverQueryLogConfigPolicy:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigPolicy'
- description: Information about the query logging policy for the query logging configuration that you specified in a GetResolverQueryLogConfigPolicy request.
GetResolverQueryLogConfigPolicyRequest:
type: object
required:
- Arn
title: GetResolverQueryLogConfigPolicyRequest
properties:
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The ARN of the query logging configuration that you want to get the query logging policy for.
UnknownResourceException: {}
GetResolverRuleResponse:
type: object
properties:
ResolverRule:
allOf:
- $ref: '#/components/schemas/ResolverRule'
- description: Information about the Resolver rule that you specified in a GetResolverRule request.
GetResolverRuleRequest:
type: object
required:
- ResolverRuleId
title: GetResolverRuleRequest
properties:
ResolverRuleId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule that you want to get information about.
GetResolverRuleAssociationResponse:
type: object
properties:
ResolverRuleAssociation:
allOf:
- $ref: '#/components/schemas/ResolverRuleAssociation'
- description: Information about the Resolver rule association that you specified in a GetResolverRuleAssociation request.
GetResolverRuleAssociationRequest:
type: object
required:
- ResolverRuleAssociationId
title: GetResolverRuleAssociationRequest
properties:
ResolverRuleAssociationId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule association that you want to get information about.
GetResolverRulePolicyResponse:
type: object
properties:
ResolverRulePolicy:
allOf:
- $ref: '#/components/schemas/ResolverRulePolicy'
- description: The Resolver rule policy for the rule that you specified in a GetResolverRulePolicy request.
GetResolverRulePolicyRequest:
type: object
required:
- Arn
title: GetResolverRulePolicyRequest
properties:
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The ID of the Resolver rule that you want to get the Resolver rule policy for.
ImportFirewallDomainsResponse:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The Id of the firewall domain list that DNS Firewall just updated.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The name of the domain list. '
Status:
allOf:
- $ref: '#/components/schemas/FirewallDomainListStatus'
- description: Status of the import request.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: Additional information about the status of the list, if available.
ImportFirewallDomainsRequest:
type: object
required:
- FirewallDomainListId
- Operation
- DomainFileUrl
title: ImportFirewallDomainsRequest
properties:
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the domain list that you want to modify with the import operation.
Operation:
allOf:
- $ref: '#/components/schemas/FirewallDomainImportOperation'
- description: 'What you want DNS Firewall to do with the domains that are listed in the file. This must be set to REPLACE, which updates the domain list to exactly match the list
in the file. '
DomainFileUrl:
allOf:
- $ref: '#/components/schemas/DomainListFileUrl'
- description: The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.
The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.
ListFirewallConfigsResponse: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request. FirewallConfigs: allOf: - $ref: '#/components/schemas/FirewallConfigList' - description: 'The configurations for the firewall behavior provided by DNS Firewall for VPCs from Amazon Virtual Private Cloud (Amazon VPC). ' ListFirewallConfigsRequest: type: object title: ListFirewallConfigsRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/ListFirewallConfigsMaxResult' - description:The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the
token that was returned for the prior request in your next request.
A list of the domain lists that you have defined.
This might be a partial list of the domain lists that you've defined. For information, see
MaxResults.
The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the
token that was returned for the prior request in your next request.
A list of the domains in the firewall domain list.
This might be a partial list of the domains that you've defined in the domain list. For information, see
MaxResults.
The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the
token that was returned for the prior request in your next request.
A list of your firewall rule group associations.
This might be a partial list of the associations that you have defined. For information, see
MaxResults.
Status setting that you want DNS Firewall to filter on for the list. If you don't specify this, then DNS Firewall returns all associations,
regardless of status.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the
token that was returned for the prior request in your next request.
A list of your firewall rule groups.
This might be a partial list of the rule groups that you have defined. For information, see MaxResults.
The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the
token that was returned for the prior request in your next request.
A list of the rules that you have defined.
This might be a partial list of the firewall rules that you've defined. For information, see MaxResults.
Optional additional filter for the rules to retrieve.
The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
Action: allOf: - $ref: '#/components/schemas/Action' - description:Optional additional filter for the rules to retrieve.
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.
The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in
MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the
token that was returned for the prior request in your next request.
If a response includes the last of the Resolver configurations that are associated with the current Amazon Web Services account, NextToken doesn't appear in
the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListResolverConfigs request. Get the
value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.
ResolverConfigs element for each Resolver configuration that is associated with the current Amazon Web Services account.
ListResolverConfigsRequest:
type: object
title: ListResolverConfigsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/ListResolverConfigsMaxResult'
- description: The maximum number of Resolver configurations that you want to return in the response to a ListResolverConfigs request. If you don't specify a value for
MaxResults, up to 100 Resolver configurations are returned.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: (Optional) If the current Amazon Web Services account has more than MaxResults Resolver configurations, use NextToken to get the second and
subsequent pages of results.
For the first ListResolverConfigs request, omit this value.
For the second and subsequent requests, get the value of
NextToken from the previous response and specify that value for NextToken in the request.
If a response includes the last of the DNSSEC configurations that are associated with the current Amazon Web Services account, NextToken doesn't appear in the
response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListResolverDnssecConfigs request. Get the value of NextToken that
Amazon Route 53 returned in the previous response and include it in NextToken in the next request.
MaxResults,
Route 53 returns up to 100 configuration per page."
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: (Optional) If the current Amazon Web Services account has more than MaxResults DNSSEC configurations, use NextToken to get the second and
subsequent pages of results.
For the first ListResolverDnssecConfigs request, omit this value.
For the second and subsequent requests, get the value of
NextToken from the previous response and specify that value for NextToken in the request.
MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group
of IP addresses. 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.
IpAddresses:
allOf:
- $ref: '#/components/schemas/IpAddressesResponse'
- description: Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).
ListResolverEndpointIpAddressesRequest:
type: object
required:
- ResolverEndpointId
title: ListResolverEndpointIpAddressesRequest
properties:
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver endpoint that you want to get IP addresses for.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: "The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults,
Resolver returns up to 100 IP addresses. "
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverEndpointIpAddresses request, omit this value.
If the specified Resolver endpoint has more than MaxResults IP
addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of
NextToken from the previous response.
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.
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.
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.
MaxResults query logging associations, you can submit another ListResolverQueryLogConfigAssociations request to get the next group
of associations. In the next request, specify the value of NextToken from the previous response. '
TotalCount:
allOf:
- $ref: '#/components/schemas/Count'
- description: The total number of query logging associations that were created by the current account in the specified Region. This count can differ from the number of associations that are
returned in a ListResolverQueryLogConfigAssociations response, depending on the values that you specify in the request.
TotalFilteredCount:
allOf:
- $ref: '#/components/schemas/Count'
- description: The total number of query logging associations that were created by the current account in the specified Region and that match the filters that were specified in the
ListResolverQueryLogConfigAssociations request. For the total number of associations that were created by the current account in the specified Region, see
TotalCount.
ResolverQueryLogConfigAssociations:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigAssociationList'
- description: A list that contains one ResolverQueryLogConfigAssociations element for each query logging association that matches the values that you specified for
Filter.
ListResolverQueryLogConfigAssociationsRequest:
type: object
title: ListResolverQueryLogConfigAssociationsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: "The maximum number of query logging associations that you want to return in the response to a ListResolverQueryLogConfigAssociations request. If you don't specify
a value for MaxResults, Resolver returns up to 100 query logging associations. "
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverQueryLogConfigAssociations request, omit this value.
If there are more than MaxResults query logging associations
that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations.
In the next request, specify the value of NextToken from the previous response.
An optional specification to return a subset of query logging associations.
If you submit a second or subsequent
ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the
previous request.
The element that you want Resolver to sort query logging associations by.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations
request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.
Valid values include the following elements:
CreationTime: The ID of the query logging association.
Error: If the value of Status is FAILED,
the value of Error indicates the cause:
DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
ACCESS_DENIED: Permissions don't allow sending logs to the destination.
If Status is a value other than FAILED, ERROR
is null.
Id: The ID of the query logging association
ResolverQueryLogConfigId: The ID of the query logging configuration
ResourceId: The ID of the VPC that is associated with the query logging configuration
Status: The current status of the configuration.
Valid values include the following:
CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.
CREATED: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging association.
FAILED: Resolver either couldn't create or couldn't delete the query
logging association. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don't allow sending logs to the destination.
If you specified a value for SortBy, the order that you want query logging associations to be listed in, ASCENDING or DESCENDING.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value
for SortOrder, if any, as in the previous request.
MaxResults query logging configurations, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations.
In the next request, specify the value of NextToken from the previous response. '
TotalCount:
allOf:
- $ref: '#/components/schemas/Count'
- description: The total number of query logging configurations that were created by the current account in the specified Region. This count can differ from the number of query logging
configurations that are returned in a ListResolverQueryLogConfigs response, depending on the values that you specify in the request.
TotalFilteredCount:
allOf:
- $ref: '#/components/schemas/Count'
- description: The total number of query logging configurations that were created by the current account in the specified Region and that match the filters that were specified in the
ListResolverQueryLogConfigs request. For the total number of query logging configurations that were created by the current account in the specified Region, see
TotalCount.
ResolverQueryLogConfigs:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigList'
- description: A list that contains one ResolverQueryLogConfig element for each query logging configuration that matches the values that you specified for Filter.
ListResolverQueryLogConfigsRequest:
type: object
title: ListResolverQueryLogConfigsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: "The maximum number of query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request. If you don't specify a value for
MaxResults, Resolver returns up to 100 query logging configurations. "
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverQueryLogConfigs request, omit this value.
If there are more than MaxResults query logging configurations that
match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next
request, specify the value of NextToken from the previous response.
An optional specification to return a subset of query logging configurations.
If you submit a second or subsequent ListResolverQueryLogConfigs
request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
The element that you want Resolver to sort query logging configurations by.
If you submit a second or subsequent ListResolverQueryLogConfigs request
and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.
Valid values include the following elements:
Arn: The ARN of the query logging configuration
AssociationCount: The number of VPCs that are associated with the specified
configuration
CreationTime: The date and time that Resolver returned when the configuration was created
CreatorRequestId: The
value that was specified for CreatorRequestId when the configuration was created
DestinationArn: The location that logs are sent to
Id: The ID of the configuration
Name: The name of the configuration
OwnerId: The Amazon Web Services account
number of the account that created the configuration
ShareStatus: Whether the configuration is shared with other Amazon Web Services accounts or shared with
the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).
Status: The current status of the configuration.
Valid values include the following:
CREATING: Resolver is creating the query logging configuration.
CREATED: The query logging
configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging configuration.
FAILED: Resolver either couldn't create or couldn't delete the query logging configuration. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don't allow sending logs to the destination.
If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or
DESCENDING.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must
use the same value for SortOrder, if any, as in the previous request.
MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation 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.
ResolverRuleAssociations:
allOf:
- $ref: '#/components/schemas/ResolverRuleAssociations'
- description: The associations that were created between Resolver rules and VPCs using the current Amazon Web Services account, and that match the specified filters, if any.
ListResolverRuleAssociationsRequest:
type: object
title: ListResolverRuleAssociationsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: "The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don't specify a value for MaxResults,
Resolver returns up to 100 rule associations. "
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverRuleAssociation request, omit this value.
If you have more than MaxResults rule associations, you can submit
another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous
response.
An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.
If you submit a second or
subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the
previous request.
MaxResults Resolver rules match the specified criteria, you can submit another ListResolverRules 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.
ResolverRules:
allOf:
- $ref: '#/components/schemas/ResolverRules'
- description: The Resolver rules that were created using the current Amazon Web Services account and that match the specified filters, if any.
ListResolverRulesRequest:
type: object
title: ListResolverRulesRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of Resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for
MaxResults, Resolver returns up to 100 Resolver rules.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverRules request, omit this value.
If you have more than MaxResults Resolver rules, you can submit another
ListResolverRules request to get the next group of Resolver rules. In the next request, specify the value of NextToken from the previous response.
An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.
If you submit
a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the
previous request.
ListTagsForResource request.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the
next request, specify the value of NextToken from the previous response. '
ListTagsForResourceRequest:
type: object
required:
- ResourceArn
title: ListTagsForResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) for the resource that you want to list tags for.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don't specify a value for MaxResults,
Resolver returns up to 100 tags.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListTagsForResource request, omit this value.
If you have more than MaxResults tags, you can submit another
ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.
PutResolverQueryLogConfigPolicy request was successful.
description: The response to a PutResolverQueryLogConfigPolicy request.
PutResolverQueryLogConfigPolicyRequest:
type: object
required:
- Arn
- ResolverQueryLogConfigPolicy
title: PutResolverQueryLogConfigPolicyRequest
properties:
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the account that you want to share rules with.
ResolverQueryLogConfigPolicy:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigPolicy'
- description: An Identity and Access Management policy statement that lists the query logging configurations that you want to share with another Amazon Web Services account and the
operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:
route53resolver:AssociateResolverQueryLogConfig
route53resolver:DisassociateResolverQueryLogConfig
route53resolver:ListResolverQueryLogConfigAssociations
route53resolver:ListResolverQueryLogConfigs
In the
Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share with the account that you specified in Arn.
PutResolverRulePolicy request was successful.
description: The response to a PutResolverRulePolicy request.
PutResolverRulePolicyRequest:
type: object
required:
- Arn
- ResolverRulePolicy
title: PutResolverRulePolicyRequest
properties:
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the rule that you want to share with another account.
ResolverRulePolicy:
allOf:
- $ref: '#/components/schemas/ResolverRulePolicy'
- description: An Identity and Access Management policy statement that lists the rules that you want to share with another Amazon Web Services account and the operations that you want the
account to be able to perform. You can specify the following operations in the Action section of the statement:
route53resolver:GetResolverRule
route53resolver:AssociateResolverRule
route53resolver:DisassociateResolverRule
route53resolver:ListResolverRules
route53resolver:ListResolverRuleAssociations
In the Resource section of the statement, specify the ARN for the rule that you want to share
with another account. Specify the same ARN that you specified in Arn.
The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:
The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:
Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.
By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall blocks queries that it is unable to evaluate properly.
If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.
This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.
UpdateFirewallDomainsResponse: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceId' - description: The ID of the firewall domain list that DNS Firewall just updated. Name: allOf: - $ref: '#/components/schemas/Name' - description: 'The name of the domain list. ' Status: allOf: - $ref: '#/components/schemas/FirewallDomainListStatus' - description: Status of theUpdateFirewallDomains request.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: Additional information about the status of the list, if available.
UpdateFirewallDomainsRequest:
type: object
required:
- FirewallDomainListId
- Operation
- Domains
title: UpdateFirewallDomainsRequest
properties:
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list whose domains you want to update. '
Operation:
allOf:
- $ref: '#/components/schemas/FirewallDomainUpdateOperation'
- description: 'What you want DNS Firewall to do with the domains that you are providing:
ADD - Add the domains to the ones that are already in the domain list.
REMOVE - Search the domain list for the domains and remove them from the list.
REPLACE - Update the domain list to exactly
match the list that you are providing.
A list of domains to use in the update operation.
There is a limit of 1000 domains per request.
Each domain specification in your domain list must satisfy the following requirements:
It can optionally start with * (asterisk).
With the exception of the optional starting asterisk,
it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen).
It must be from 1-255 characters in length.
The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
Action: allOf: - $ref: '#/components/schemas/Action' - description:The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the
request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the
request. This option requires additional details in the rule's BlockResponse.
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
NODATA - Respond indicating
that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't
exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride*
settings.
BLOCK with a BlockResponse setting of OVERRIDE.
BlockOverrideDnsType:
allOf:
- $ref: '#/components/schemas/BlockOverrideDnsType'
- description: The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
BlockOverrideTtl:
allOf:
- $ref: '#/components/schemas/BlockOverrideTtl'
- description: The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the rule.
UpdateFirewallRuleGroupAssociationResponse:
type: object
properties:
FirewallRuleGroupAssociation:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupAssociation'
- description: 'The association that you just updated. '
UpdateFirewallRuleGroupAssociationRequest:
type: object
required:
- FirewallRuleGroupAssociationId
title: UpdateFirewallRuleGroupAssociationRequest
properties:
FirewallRuleGroupAssociationId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The identifier of the FirewallRuleGroupAssociation. '
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.
You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for a rule group association after you create it.
MutationProtection: allOf: - $ref: '#/components/schemas/MutationProtectionStatus' - description: 'If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. ' Name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the rule group association. UpdateResolverConfigResponse: type: object properties: ResolverConfig: allOf: - $ref: '#/components/schemas/ResolverConfig' - description: An array that contains settings for the specified Resolver configuration. UpdateResolverConfigRequest: type: object required: - ResourceId - AutodefinedReverseFlag title: UpdateResolverConfigRequest properties: ResourceId: allOf: - $ref: '#/components/schemas/ResourceId' - description: Resource ID of the Amazon VPC that you want to update the Resolver configuration for. AutodefinedReverseFlag: allOf: - $ref: '#/components/schemas/AutodefinedReverseFlag' - description:Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. Disabling this option will also affect EC2-Classic instances using ClassicLink. For more information, see ClassicLink in the Amazon EC2 guide.
We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – Here’s How to Prepare.
It can take some time for the status change to be completed.
ENABLE or DISABLE. Be aware that it can take time for a
validation status change to be completed.
UpdateResolverEndpointResponse:
type: object
properties:
ResolverEndpoint:
allOf:
- $ref: '#/components/schemas/ResolverEndpoint'
- description: The response to an UpdateResolverEndpoint request.
UpdateResolverEndpointRequest:
type: object
required:
- ResolverEndpointId
title: UpdateResolverEndpointRequest
properties:
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver endpoint that you want to update.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the Resolver endpoint that you want to update.
ResolverEndpointType:
allOf:
- $ref: '#/components/schemas/ResolverEndpointType'
- description: ' Specifies the endpoint type for what type of IP address the endpoint uses to forward DNS queries. '
UpdateIpAddresses:
allOf:
- $ref: '#/components/schemas/UpdateIpAddresses'
- description: ' Updates the Resolver endpoint type to IpV4, Ipv6, or dual-stack. '
UpdateResolverRuleResponse:
type: object
properties:
ResolverRule:
allOf:
- $ref: '#/components/schemas/ResolverRule'
- description: The response to an UpdateResolverRule request.
UpdateResolverRuleRequest:
type: object
required:
- ResolverRuleId
- Config
title: UpdateResolverRuleRequest
properties:
ResolverRuleId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule that you want to update.
Config:
allOf:
- $ref: '#/components/schemas/ResolverRuleConfig'
- description: The new settings for the Resolver rule.
AccountId:
type: string
minLength: 12
maxLength: 32
Action:
type: string
enum:
- ALLOW
- BLOCK
- ALERT
Arn:
type: string
minLength: 1
maxLength: 255
CreatorRequestId:
type: string
minLength: 1
maxLength: 255
ResourceId:
type: string
minLength: 1
maxLength: 64
Priority:
type: integer
Name:
type: string
pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)
maxLength: 64
MutationProtectionStatus:
type: string
enum:
- ENABLED
- DISABLED
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
maxItems: 200
FirewallRuleGroupAssociation:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The identifier for the association.
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the firewall rule group association.
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group. '
VpcId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the VPC that is associated with the rule group. '
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the association.
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: 'The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from rule
group with the lowest numeric priority setting. '
MutationProtection:
allOf:
- $ref: '#/components/schemas/MutationProtectionStatus'
- description: 'If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. '
ManagedOwnerName:
allOf:
- $ref: '#/components/schemas/ServicePrinciple'
- description: The owner of the association, used only for associations that are not managed by you. If you use Firewall Manager to manage your DNS Firewalls, then this reports Firewall
Manager as the managed owner.
Status:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupAssociationStatus'
- description: The current status of the association.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: Additional information about the status of the response, if available.
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string,
for example, a timestamp. '
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: 'The date and time that the association was created, in Unix time format and Coordinated Universal Time (UTC). '
ModificationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC).
description: 'An association between a firewall rule group and a VPC, which enables DNS filtering for the VPC. '
IpAddressUpdate:
type: object
properties:
IpId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: ' Only when removing an IP address from a Resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.'
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- description: The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.
Ip:
allOf:
- $ref: '#/components/schemas/Ip'
- description: The new IPv4 address.
Ipv6:
allOf:
- $ref: '#/components/schemas/Ipv6'
- description: ' The new IPv6 address. '
description: In an UpdateResolverEndpoint request, information about an IP
address to update.
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:
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.
The status of the specified query logging association. Valid values include the following:
CREATING: Resolver is creating an association between
an Amazon VPC and a query logging configuration.
CREATED: The association between an Amazon VPC and a query logging configuration was successfully created.
Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging association.
FAILED:
Resolver either couldn't create or couldn't delete the query logging association.
If the value of Status is FAILED, the value of Error indicates the cause:
DESTINATION_NOT_FOUND: The specified
destination (for example, an Amazon S3 bucket) was deleted.
ACCESS_DENIED: Permissions don't allow sending logs to the destination.
If the
value of Status is a value other than FAILED, Error is null.
Error is null, the value of ErrorMessage also is null.
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
description: In the response to an AssociateResolverQueryLogConfig,
DisassociateResolverQueryLogConfig, GetResolverQueryLogConfigAssociation, or ListResolverQueryLogConfigAssociations, request, a complex
type that contains settings for a specified association between an Amazon VPC and a query logging configuration.
ResolverRuleAssociation:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.
ResolverRuleId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule that you associated with the VPC that is specified by VPCId.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of an association between a Resolver rule and a VPC.
VPCId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the VPC that you associated the Resolver rule with.
Status:
allOf:
- $ref: '#/components/schemas/ResolverRuleAssociationStatus'
- description: A code that specifies the current status of the association between a Resolver rule and a VPC.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: A detailed description of the status of the association between a Resolver rule and a VPC.
description: 'In the response to an AssociateResolverRule, DisassociateResolverRule,
or ListResolverRuleAssociations request, provides information about an
association between a Resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network. '
AutodefinedReverseFlag:
type: string
enum:
- ENABLE
- DISABLE
- USE_LOCAL_RESOURCE_SETTING
BlockOverrideDnsType:
type: string
enum:
- CNAME
BlockOverrideDomain:
type: string
minLength: 1
maxLength: 255
BlockOverrideTtl:
type: integer
minimum: 0
maximum: 604800
BlockResponse:
type: string
enum:
- NODATA
- NXDOMAIN
- OVERRIDE
Boolean:
type: boolean
Count:
type: integer
FirewallDomainList:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list. '
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the firewall domain list.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The name of the domain list. '
DomainCount:
allOf:
- $ref: '#/components/schemas/Unsigned'
- description: The number of domain names that are specified in the domain list.
Status:
allOf:
- $ref: '#/components/schemas/FirewallDomainListStatus'
- description: 'The status of the domain list. '
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: Additional information about the status of the list, if available.
ManagedOwnerName:
allOf:
- $ref: '#/components/schemas/ServicePrinciple'
- description: The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed
owner name Route 53 Resolver DNS Firewall.
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string,
for example, a timestamp. '
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: 'The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC). '
ModificationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: 'The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC). '
description: High-level information about a list of firewall domains for use in a FirewallRule. This is returned by GetFirewallDomainList.
To retrieve the domains that are defined for this domain list, call ListFirewallDomains.
FirewallRuleGroup: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceId' - description: 'The ID of the rule group. ' Arn: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN (Amazon Resource Name) of the rule group. Name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the rule group. RuleCount: allOf: - $ref: '#/components/schemas/Unsigned' - description: The number of rules in the rule group. Status: allOf: - $ref: '#/components/schemas/FirewallRuleGroupStatus' - description: 'The status of the domain list. ' StatusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: Additional information about the status of the rule group, if available. OwnerId: allOf: - $ref: '#/components/schemas/AccountId' - description: 'The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you. ' CreatorRequestId: allOf: - $ref: '#/components/schemas/CreatorRequestId' - description: 'A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp. ' ShareStatus: allOf: - $ref: '#/components/schemas/ShareStatus' - description: Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM). CreationTime: allOf: - $ref: '#/components/schemas/Rfc3339TimeString' - description: 'The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC). ' ModificationTime: allOf: - $ref: '#/components/schemas/Rfc3339TimeString' - description: The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC). description: High-level information for a firewall rule group. A firewall rule group is a collection of rules that DNS Firewall uses to filter DNS network traffic for a VPC. To retrieve the rules for the rule group, call ListFirewallRules. FirewallRule: type: object properties: FirewallRuleGroupId: allOf: - $ref: '#/components/schemas/ResourceId' - description: 'The unique identifier of the firewall rule group of the rule. ' FirewallDomainListId: allOf: - $ref: '#/components/schemas/ResourceId' - description: "The ID of the domain list that's used in the rule. " Name: allOf: - $ref: '#/components/schemas/Name' - description: 'The name of the rule. ' Priority: allOf: - $ref: '#/components/schemas/Priority' - description: The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting. Action: allOf: - $ref: '#/components/schemas/Action' - description:The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the
request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the
request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
NODATA - Respond indicating
that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't
exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride*
settings.
BLOCK with a BlockResponse setting of OVERRIDE.
BlockOverrideDnsType:
allOf:
- $ref: '#/components/schemas/BlockOverrideDnsType'
- description: The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
BlockOverrideTtl:
allOf:
- $ref: '#/components/schemas/Unsigned'
- description: The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string,
for example, a timestamp. '
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: 'The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC). '
ModificationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).
description: A single firewall rule in a rule group.
SecurityGroupIds:
type: array
items:
$ref: '#/components/schemas/ResourceId'
ResolverEndpointDirection:
type: string
enum:
- INBOUND
- OUTBOUND
IpAddressesRequest:
type: array
items:
$ref: '#/components/schemas/IpAddressRequest'
minItems: 1
maxItems: 20
ResolverEndpointType:
type: string
enum:
- IPV6
- IPV4
- DUALSTACK
ResolverQueryLogConfigName:
type: string
pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)
minLength: 1
maxLength: 64
DestinationArn:
type: string
minLength: 1
maxLength: 600
ResolverQueryLogConfig:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID for the query logging configuration.
OwnerId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: 'The Amazon Web Services account ID for the account that created the query logging configuration. '
Status:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigStatus'
- description: "The status of the specified query logging configuration. Valid values include the following:
CREATING: Resolver is creating the query logging
configuration.
CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging configuration.
FAILED: Resolver can't deliver logs to the location that is specified
in the query logging configuration. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don't allow sending logs to the destination.
CreatorRequestId allows failed requests to be retried without the
risk of running the operation twice.
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
description: In the response to a CreateResolverQueryLogConfig, DeleteResolverQueryLogConfig, GetResolverQueryLogConfig, or ListResolverQueryLogConfigs request, a complex type that contains
settings for one query logging configuration.
RuleTypeOption:
type: string
enum:
- FORWARD
- SYSTEM
- RECURSIVE
DomainName:
type: string
minLength: 1
maxLength: 256
TargetList:
type: array
items:
$ref: '#/components/schemas/TargetAddress'
minItems: 1
ResolverRule:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID that Resolver assigned to the Resolver rule when you created it.
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and 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 rule specified by Id.
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules (example.com and
www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).
Status:
allOf:
- $ref: '#/components/schemas/ResolverRuleStatus'
- description: A code that specifies the current status of the Resolver rule.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: A detailed description of the status of a Resolver rule.
RuleType:
allOf:
- $ref: '#/components/schemas/RuleTypeOption'
- description: When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.
When you have a forwarding rule to forward
DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
For example, to forward DNS queries
for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com,
you create a rule and specify SYSTEM for RuleType.
Currently, only Resolver can create rules that have a value of RECURSIVE for
RuleType.
ResolverRule parameter
appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.
DomainListFileUrl:
type: string
minLength: 1
maxLength: 1024
FilterName:
type: string
minLength: 1
maxLength: 64
FilterValues:
type: array
items:
$ref: '#/components/schemas/FilterValue'
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:
CreatorRequestId: The value that you specified when you created the Resolver endpoint.
Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify DIRECTION for Name, specify INBOUND
or OUTBOUND for Values.
HostVPCId: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs
in a region, or the VPC that outbound queries pass through on the way from your VPCs to your network. In a CreateResolverEndpoint request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint request, the VPC ID for a Resolver endpoint is returned in the HostVPCId element.
IpAddressCount: The number of IP addresses
that you have associated with the Resolver endpoint.
Name: The name of the Resolver endpoint.
SecurityGroupIds: The IDs of the
VPC security groups that you specified when you created the Resolver endpoint.
Status: The status of the Resolver endpoint. If you specify Status
for Name, specify one of the following status codes for Values: CREATING, OPERATIONAL, UPDATING, AUTO_RECOVERING,
ACTION_NEEDED, or DELETING. For more information, see Status in ResolverEndpoint.
ListResolverRules
Valid values for Name include the following:
CreatorRequestId: The value
that you specified when you created the Resolver rule.
DomainName: The domain name for which Resolver is forwarding DNS queries to your network. In the value
that you specify for Values, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the \".\" after
com:
example.com.
Name: The name of the Resolver rule.
ResolverEndpointId: The ID of the
Resolver endpoint that the Resolver rule is associated with.
You can filter on the Resolver endpoint only for rules that have a value of FORWARD for RuleType.
Status: The status of the Resolver rule. If you specify Status for Name, specify one of the following status codes for Values:
COMPLETE, DELETING, UPDATING, or FAILED.
Type: The type of the Resolver rule. If you specify TYPE
for Name, specify FORWARD or SYSTEM for Values.
ListResolverRuleAssociations
Valid values for Name
include the following:
Name: The name of the Resolver rule association.
ResolverRuleId: The ID of the Resolver rule that is associated
with one or more VPCs.
Status: The status of the Resolver rule association. If you specify Status for Name, specify one of the following
status codes for Values: CREATING, COMPLETE, DELETING, or FAILED.
VPCId: The ID of the VPC
that the Resolver rule is associated with.
ListResolverQueryLogConfigs
Valid values for Name include the following:
Arn:
The ARN for the query logging configuration.
AssociationCount: The number of VPCs that are associated with the query logging configuration.
CreationTime: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId:
A unique string that identifies the request that created the query logging configuration.
Destination: The Amazon Web Services service that you want to forward
query logs to. Valid values include the following:
S3
CloudWatchLogs
KinesisFirehose
DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an S3 bucket, a CloudWatch Logs log group, or
a Kinesis Data Firehose delivery stream.
Id: The ID of the query logging configuration
Name: The name of the query logging configuration
OwnerId: The Amazon Web Services account ID for the account that created the query logging configuration.
ShareStatus: An indication
of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Valid values include:
NOT_SHARED, SHARED_WITH_ME, or SHARED_BY_ME.
Status: The status of the query logging configuration. If you specify Status
for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information,
see Status.
ListResolverQueryLogConfigAssociations
Valid values for Name include the following:
CreationTime: The date and
time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
Error: If the value of Status
is FAILED, specify the cause: DESTINATION_NOT_FOUND or ACCESS_DENIED.
Id: The ID of the query logging association.
ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.
ResourceId: The ID of the Amazon
VPC that is associated with the query logging configuration.
Status: The status of the query logging association. If you specify Status for Name,
specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.
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.
Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.
By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall returns a failure error when it is unable to properly evaluate a query.
If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.
This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.
description: 'Configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC). ' FirewallConfigList: type: array items: $ref: '#/components/schemas/FirewallConfig' FirewallDomainImportOperation: type: string enum: - REPLACE Unsigned: type: integer FirewallDomainListStatus: type: string enum: - COMPLETE - COMPLETE_IMPORT_FAILED - IMPORTING - DELETING - UPDATING StatusMessage: type: string maxLength: 255 ServicePrinciple: type: string minLength: 1 maxLength: 512 Rfc3339TimeString: type: string minLength: 20 maxLength: 40 FirewallDomainListMetadata: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceId' - description: 'The ID of the domain list. ' Arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the firewall domain list metadata. Name: allOf: - $ref: '#/components/schemas/Name' - description: 'The name of the domain list. ' CreatorRequestId: allOf: - $ref: '#/components/schemas/CreatorRequestId' - description: 'A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp. ' ManagedOwnerName: allOf: - $ref: '#/components/schemas/ServicePrinciple' - description: The owner of the list, used only for lists that are not managed by you. For example, the managed domain listAWSManagedDomainsMalwareDomainList has the managed
owner name Route 53 Resolver DNS Firewall.
description: Minimal high-level information for a firewall domain list. The action ListFirewallDomainLists returns an array of these objects.
To retrieve full information for a firewall domain list, call GetFirewallDomainList and ListFirewallDomains.
FirewallDomainListMetadataList: type: array items: $ref: '#/components/schemas/FirewallDomainListMetadata' FirewallDomainName: type: string minLength: 1 maxLength: 255 FirewallDomainUpdateOperation: type: string enum: - ADD - REMOVE - REPLACE FirewallDomains: type: array items: $ref: '#/components/schemas/FirewallDomainName' FirewallRuleGroupStatus: type: string enum: - COMPLETE - DELETING - UPDATING ShareStatus: type: string enum: - NOT_SHARED - SHARED_WITH_ME - SHARED_BY_ME FirewallRuleGroupAssociationStatus: type: string enum: - COMPLETE - DELETING - UPDATING FirewallRuleGroupAssociations: type: array items: $ref: '#/components/schemas/FirewallRuleGroupAssociation' FirewallRuleGroupMetadata: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceId' - description: 'The ID of the rule group. ' Arn: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN (Amazon Resource Name) of the rule group. Name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the rule group. OwnerId: allOf: - $ref: '#/components/schemas/AccountId' - description: 'The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you. ' CreatorRequestId: allOf: - $ref: '#/components/schemas/CreatorRequestId' - description: 'A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp. ' ShareStatus: allOf: - $ref: '#/components/schemas/ShareStatus' - description: Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM). description:Minimal high-level information for a firewall rule group. The action ListFirewallRuleGroups returns an array of these objects.
To retrieve full information for a firewall rule group, call GetFirewallRuleGroup and ListFirewallRules.
FirewallRuleGroupMetadataList: type: array items: $ref: '#/components/schemas/FirewallRuleGroupMetadata' FirewallRuleGroupPolicy: type: string maxLength: 30000 FirewallRules: type: array items: $ref: '#/components/schemas/FirewallRule' ResolverConfig: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceId' - description: ID for the Resolver configuration. ResourceId: allOf: - $ref: '#/components/schemas/ResourceId' - description: The ID of the Amazon Virtual Private Cloud VPC that you're configuring Resolver for. OwnerId: allOf: - $ref: '#/components/schemas/AccountId' - description: The owner account ID of the Amazon Virtual Private Cloud VPC. AutodefinedReverse: allOf: - $ref: '#/components/schemas/ResolverAutodefinedReverseStatus' - description:The status of whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. The status can be one of following:
ENABLING: Autodefined rules for reverse DNS lookups are being enabled but are not complete.
ENABLED: Autodefined rules for reverse DNS lookups are enabled.
DISABLING: Autodefined rules for reverse DNS lookups are being disabled but are not complete.
DISABLED: Autodefined rules for reverse DNS lookups are disabled.
The validation status for a DNSSEC configuration. The status can be one of the following:
ENABLING: DNSSEC validation is being enabled but is not complete.
ENABLED: DNSSEC validation is enabled.
DISABLING: DNSSEC validation is being disabled but is not complete.
DISABLED DNSSEC validation is disabled.
IpAddressRequest also includes the ID of the subnet that contains the
IP address.
IpAddressStatus:
type: string
enum:
- CREATING
- FAILED_CREATION
- ATTACHING
- ATTACHED
- REMAP_DETACHING
- REMAP_ATTACHING
- DETACHING
- FAILED_RESOURCE_GONE
- DELETING
- DELETE_FAILED_FAS_EXPIRED
- UPDATING
IpAddressResponse:
type: object
properties:
IpId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of one IP address.
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- description: The ID of one subnet.
Ip:
allOf:
- $ref: '#/components/schemas/Ip'
- description: One IPv4 address that the Resolver endpoint uses for DNS queries.
Ipv6:
allOf:
- $ref: '#/components/schemas/Ipv6'
- description: ' One IPv6 address that the Resolver endpoint uses for DNS queries. '
Status:
allOf:
- $ref: '#/components/schemas/IpAddressStatus'
- description: A status code that gives the current status of the request.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: A message that provides additional information about the status of the request.
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).
description: In the response to a GetResolverEndpoint request, information
about the IP addresses that the Resolver endpoint uses for DNS queries.
IpAddressesResponse:
type: array
items:
$ref: '#/components/schemas/IpAddressResponse'
ListDomainMaxResults:
type: integer
minimum: 1
maximum: 5000
ListFirewallConfigsMaxResult:
type: integer
minimum: 5
maximum: 10
NextToken:
type: string
MaxResults:
type: integer
minimum: 1
maximum: 100
ListResolverConfigsMaxResult:
type: integer
minimum: 5
maximum: 100
ResolverConfigList:
type: array
items:
$ref: '#/components/schemas/ResolverConfig'
ResolverDnssecConfigList:
type: array
items:
$ref: '#/components/schemas/ResolverDnssecConfig'
ResolverEndpoints:
type: array
items:
$ref: '#/components/schemas/ResolverEndpoint'
SortByKey:
type: string
minLength: 1
maxLength: 64
SortOrder:
type: string
enum:
- ASCENDING
- DESCENDING
ResolverQueryLogConfigAssociationList:
type: array
items:
$ref: '#/components/schemas/ResolverQueryLogConfigAssociation'
ResolverQueryLogConfigList:
type: array
items:
$ref: '#/components/schemas/ResolverQueryLogConfig'
ResolverRuleAssociations:
type: array
items:
$ref: '#/components/schemas/ResolverRuleAssociation'
ResolverRules:
type: array
items:
$ref: '#/components/schemas/ResolverRule'
Port:
type: integer
minimum: 0
maximum: 65535
ResolverAutodefinedReverseStatus:
type: string
enum:
- ENABLING
- ENABLED
- DISABLING
- DISABLED
- UPDATING_TO_USE_LOCAL_RESOURCE_SETTING
- USE_LOCAL_RESOURCE_SETTING
ResolverDNSSECValidationStatus:
type: string
enum:
- ENABLING
- ENABLED
- DISABLING
- DISABLED
- UPDATING_TO_USE_LOCAL_RESOURCE_SETTING
- USE_LOCAL_RESOURCE_SETTING
ResolverEndpointStatus:
type: string
enum:
- CREATING
- OPERATIONAL
- UPDATING
- AUTO_RECOVERING
- ACTION_NEEDED
- DELETING
ResolverQueryLogConfigStatus:
type: string
enum:
- CREATING
- CREATED
- DELETING
- FAILED
ResolverQueryLogConfigAssociationStatus:
type: string
enum:
- CREATING
- ACTIVE
- ACTION_NEEDED
- DELETING
- FAILED
ResolverQueryLogConfigAssociationError:
type: string
enum:
- NONE
- DESTINATION_NOT_FOUND
- ACCESS_DENIED
- INTERNAL_SERVICE_ERROR
ResolverQueryLogConfigAssociationErrorMessage:
type: string
ResolverRuleStatus:
type: string
enum:
- COMPLETE
- DELETING
- UPDATING
- FAILED
ResolverRuleAssociationStatus:
type: string
enum:
- CREATING
- COMPLETE
- DELETING
- FAILED
- OVERRIDDEN
ResolverRuleConfig:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The new name for the Resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console. '
TargetIps:
allOf:
- $ref: '#/components/schemas/TargetList'
- description: For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the new outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.
description: In an UpdateResolverRule request, information about the changes
that you want to make.
TagKey:
type: string
minLength: 1
maxLength: 128
TagValue:
type: string
minLength: 0
maxLength: 256
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.
TagKeyList:
type: array
items:
$ref: '#/components/schemas/TagKey'
maxItems: 200
TargetAddress:
type: object
properties:
Ip:
allOf:
- $ref: '#/components/schemas/Ip'
- description: One IPv4 address that you want to forward DNS queries to.
Port:
allOf:
- $ref: '#/components/schemas/Port'
- description: The port at Ip that you want to forward DNS queries to.
Ipv6:
allOf:
- $ref: '#/components/schemas/Ipv6'
- description: ' One IPv6 address that you want to forward DNS queries to. '
description: In a CreateResolverRule request, an array of the IPs that you want
to forward DNS queries to.
UpdateIpAddress:
type: object
required:
- IpId
- Ipv6
properties:
IpId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: ' The ID of the IP address, specified by the ResolverEndpointId. '
Ipv6:
allOf:
- $ref: '#/components/schemas/Ipv6'
- description: ' The IPv6 address that you want to use for DNS queries. '
description: ' Provides information about the IP address type in response to UpdateResolverEndpoint. '
UpdateIpAddresses:
type: array
items:
$ref: '#/components/schemas/UpdateIpAddress'
minItems: 0
maxItems: 50
Validation:
type: string
enum:
- ENABLE
- DISABLE
- USE_LOCAL_RESOURCE_SETTING
security:
- hmac: []