CreateAccessSource - Amazon Route 53

CreateAccessSource

Creates an access source for a DNS view. Access sources define IP addresses or CIDR ranges that are allowed to send DNS queries to the Route 53 Global Resolver, along with the permitted DNS protocols.

Request Syntax

POST /access-sources HTTP/1.1 Content-type: application/json { "cidr": "string", "clientToken": "string", "dnsViewId": "string", "ipAddressType": "string", "name": "string", "protocol": "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.

cidr

The IP address or CIDR range that is allowed to send DNS queries to the Route 53 Global Resolver.

Type: String

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

Required: Yes

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

dnsViewId

The ID of the DNS view to associate with this access source.

Type: String

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

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

Required: Yes

ipAddressType

The IP address type for this access source. Valid values are IPv4 and IPv6 (if the Route 53 Global Resolver supports dual-stack).

Type: String

Valid Values: IPV4 | IPV6

Required: No

name

A descriptive name for the access source.

Type: String

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

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

Required: No

protocol

The DNS protocol that is permitted for this access source. Valid values are Do53 (DNS over port 53), DoT (DNS over TLS), and DoH (DNS over HTTPS).

Type: String

Valid Values: DO53 | DOH | DOT

Required: Yes

tags

Tags to associate with the access source.

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", "cidr": "string", "createdAt": "string", "dnsViewId": "string", "id": "string", "ipAddressType": "string", "name": "string", "protocol": "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 access source.

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}

cidr

The IP address or CIDR range that is allowed to send DNS queries to the Route 53 Global Resolver.

Type: String

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

createdAt

The date and time when the access source was created.

Type: Timestamp

dnsViewId

The ID of the DNS view associated with this access source.

Type: String

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

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

id

The unique identifier for the access source.

Type: String

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

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

ipAddressType

The IP address type for this access source (IPv4 or IPv6).

Type: String

Valid Values: IPV4 | IPV6

name

The descriptive name of the access source.

Type: String

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

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

protocol

The DNS protocol that is permitted for this access source (Do53, DoT, or DoH).

Type: String

Valid Values: DO53 | DOH | DOT

status

The operational status of the access source.

Type: String

Valid Values: CREATING | OPERATIONAL | UPDATING | DELETING

updatedAt

The date and time when the access source 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: