CreateDNSView - Amazon Route 53

CreateDNSView

Creates a DNS view within a Route 53 Global Resolver. A DNS view models end users, user groups, networks, and devices, and serves as a parent resource that holds configurations controlling access, authorization, DNS firewall rules, and forwarding rules.

Request Syntax

POST /dns-views/globalResolverId HTTP/1.1 Content-type: application/json { "clientToken": "string", "description": "string", "dnssecValidation": "string", "ednsClientSubnet": "string", "firewallRulesFailOpen": "string", "name": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.

globalResolverId

The ID of the Route 53 Global Resolver to associate with this DNS view.

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

Pattern: [-.a-zA-Z0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique string that identifies the request and ensures idempotency.

Type: String

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

Required: No

description

An optional description for the DNS view.

Type: String

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

Required: No

dnssecValidation

Whether to enable DNSSEC validation for DNS queries in this DNS view. When enabled, the resolver verifies the authenticity and integrity of DNS responses from public name servers for DNSSEC-signed domains.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

ednsClientSubnet

Whether to enable EDNS Client Subnet injection for DNS queries in this DNS view. When enabled, client subnet information is forwarded to provide more accurate geographic-based DNS responses.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

firewallRulesFailOpen

Determines the behavior when Route 53 Global Resolver cannot apply DNS firewall rules due to service impairment. When enabled, DNS queries are allowed through; when disabled, queries are blocked.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

name

A descriptive name for the DNS view.

Type: String

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

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

Required: Yes

tags

Tags to associate with the DNS view.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "arn": "string", "clientToken": "string", "createdAt": "string", "description": "string", "dnssecValidation": "string", "ednsClientSubnet": "string", "firewallRulesFailOpen": "string", "globalResolverId": "string", "id": "string", "name": "string", "status": "string", "updatedAt": "string" }

Response Elements

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

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

arn

The Amazon Resource Name (ARN) of the DNS view.

Type: String

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

Pattern: arn:[-.a-z0-9]{1,63}:[-.a-z0-9]{1,63}:[-.a-z0-9]{0,63}:[-.a-z0-9]{0,63}:[^/].{0,1023}

clientToken

The unique string that identifies the request and ensures idempotency.

Type: String

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

createdAt

The date and time when the DNS view was created.

Type: Timestamp

description

The description of the DNS view.

Type: String

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

dnssecValidation

Whether DNSSEC validation is enabled for DNS queries in this DNS view.

Type: String

Valid Values: ENABLED | DISABLED

ednsClientSubnet

Whether EDNS Client Subnet injection is enabled for DNS queries in this DNS view.

Type: String

Valid Values: ENABLED | DISABLED

firewallRulesFailOpen

The behavior when Route 53 Global Resolver cannot apply DNS firewall rules due to service impairment.

Type: String

Valid Values: ENABLED | DISABLED

globalResolverId

The ID of the Route 53 Global Resolver instance the DNS view is created for.

Type: String

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

Pattern: [-.a-zA-Z0-9]+

id

The unique identifier for the DNS view.

Type: String

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

Pattern: [-.a-zA-Z0-9]+

name

The descriptive name of the DNS view.

Type: String

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

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

status

The operational status of the DNS view.

Type: String

Valid Values: CREATING | OPERATIONAL | UPDATING | ENABLING | DISABLING | DISABLED | DELETING

updatedAt

The date and time when the DNS view was last updated.

Type: Timestamp

Errors

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

AccessDeniedException

You don't have permission to perform this operation. Check your IAM permissions and try again.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource. This can occur when trying to modify a resource that is not in a valid state for the requested operation.

resourceId

The ID of the conflicting resource.

resourceType

The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

An internal server error occurred. Try again later.

retryAfterSeconds

Number of seconds in which the caller can retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found. Verify the resource ID and try again.

resourceId

The unique ID of the resource referenced in the failed request.

resourceType

The resource type of the resource referenced in the failed request.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would exceed one or more service quotas. Check your current usage and quotas, then try again.

quotaCode

The quota code recognized by the AWS Service Quotas service.

resourceId

The unique ID of the resource referenced in the failed request.

resourceType

The resource type of the resource referenced in the failed request.

serviceCode

The code for the AWS service that owns the quota.

HTTP Status Code: 402

ThrottlingException

The request was throttled due to too many requests. Wait a moment and try again.

quotaCode

The quota code recognized by the AWS Service Quotas service.

retryAfterSeconds

Number of seconds in which the caller can retry the request.

serviceCode

The code for the AWS service that owns the quota.

HTTP Status Code: 429

ValidationException

The input parameters are invalid. Check the parameter values and try again.

fieldList

The list of fields that aren't valid.

reason

Reason the request failed validation.

HTTP Status Code: 400

See Also

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