CreateGlobalResolver - Amazon Route 53

CreateGlobalResolver

Creates a new Route 53 Global Resolver instance. A Route 53 Global Resolver is a global, internet-accessible DNS resolver that provides secure DNS resolution for both public and private domains through global anycast IP addresses.

Request Syntax

POST /global-resolver HTTP/1.1 Content-type: application/json { "clientToken": "string", "description": "string", "name": "string", "observabilityRegion": "string", "regions": [ "string" ], "tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A unique string that identifies the request and ensures idempotency. If you make multiple requests with the same client token, only one Route 53 Global Resolver is created.

Type: String

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

Required: No

description

An optional description for the Route 53 Global Resolver instance. Maximum length of 1024 characters.

Type: String

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

Required: No

name

A descriptive name for the Route 53 Global Resolver instance. Maximum length of 64 characters.

Type: String

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

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

Required: Yes

observabilityRegion

The AWS Region where query resolution logs and metrics will be aggregated and delivered. If not specified, logging is not enabled.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32.

Required: No

regions

List of AWS Regions where the Route 53 Global Resolver will operate. The resolver will be distributed across these Regions to provide global availability and low-latency DNS resolution.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 32.

Required: Yes

tags

Tags to associate with the Route 53 Global Resolver. Tags are key-value pairs that help you organize and identify your resources.

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", "dnsName": "string", "id": "string", "ipv4Addresses": [ "string" ], "name": "string", "observabilityRegion": "string", "regions": [ "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 Route 53 Global Resolver.

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 Route 53 Global Resolver was created.

Type: Timestamp

description

The description of the Route 53 Global Resolver.

Type: String

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

dnsName

The hostname that DNS clients should use for TLS certificate validation when connecting to the Route 53 Global Resolver. This value resolves to the global anycast IP addresses for the resolver.

Type: String

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

id

The unique identifier for the Route 53 Global Resolver.

Type: String

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

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

ipv4Addresses

The global anycast IPv4 addresses associated with the Route 53 Global Resolver. DNS clients can send queries to these addresses from anywhere on the internet.

Type: Array of strings

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

Pattern: ((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}

name

The name of the Route 53 Global Resolver.

Type: String

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

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

observabilityRegion

The AWS Region where observability data for the Route 53 Global Resolver is stored.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32.

regions

The AWS Regions where the Route 53 Global Resolver is deployed and operational.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 32.

status

The current status of the Route 53 Global Resolver. Possible values are CREATING (being provisioned), UPDATING (being modified), OPERATIONAL (ready to serve queries), or DELETING (being removed).

Type: String

Valid Values: CREATING | OPERATIONAL | UPDATING | DELETING

updatedAt

The date and time when the Route 53 Global Resolver 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

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: