Amazon Route 53 Global Resolver

2026/11/17 - Amazon Route 53 Global Resolver - 5 new 9 updated api methods

Changes  Adds AWS Cloud WAN support to Route 53 Global Resolver via new core network endpoint APIs to connect a global resolver to a core network, segment-based access sources, and a publicIpStatus setting to disable public IPs so a resolver is reachable only over Cloud WAN.

CreateCoreNetworkEndpoint (new) Link ¶

Creates a core network endpoint, which enables DNS resolution for Amazon Web Services Cloud WAN core network segments. The endpoint connects a Route 53 Global Resolver to an Amazon Web Services Cloud WAN core network so that resources attached to the core network can send DNS queries to the resolver.

See also: AWS API Documentation

Request Syntax

client.create_core_network_endpoint(
    clientToken='string',
    coreNetworkArn='string',
    globalResolverId='string',
    ipAddresses=[
        {
            'ipv4Address': 'string',
            'ipv6Address': 'string',
            'dnsLabel': 'string',
            'regionScope': 'ALL'|'REGIONAL',
            'regions': [
                'string',
            ]
        },
    ],
    name='string',
    tags={
        'string': 'string'
    }
)
type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that ensures the request is idempotent. Making the same request multiple times with the same clientToken produces the same result every time.

This field is autopopulated if not provided.

type coreNetworkArn:

string

param coreNetworkArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon Web Services Cloud WAN core network to connect to this endpoint.

type globalResolverId:

string

param globalResolverId:

[REQUIRED]

The ID of the Route 53 Global Resolver to associate with this core network endpoint.

type ipAddresses:

list

param ipAddresses:

[REQUIRED]

The IP addresses that the core network endpoint uses to resolve DNS queries within the Amazon Web Services Cloud WAN core network.

  • (dict) --

    A DNS IP address configuration that you provide when you create a core network endpoint. Each item specifies an IP address for the endpoint to receive DNS queries, along with its DNS label, and the scope and Amazon Web Services Regions in which the address applies.

    • ipv4Address (string) --

      The IPv4 address for the core network endpoint to receive DNS queries.

    • ipv6Address (string) --

      The IPv6 address for the core network endpoint to receive DNS queries.

    • dnsLabel (string) -- [REQUIRED]

      The DNS label to associate with the IP address.

    • regionScope (string) -- [REQUIRED]

      Indicates whether the IP address applies to all Amazon Web Services Regions or only to the specific Regions that you identify. When the value is REGIONAL, the Regions are listed in the regions field.

    • regions (list) --

      The Amazon Web Services Regions in which the IP address applies when the region scope is REGIONAL.

      • (string) --

type name:

string

param name:

A descriptive name for the core network endpoint.

type tags:

dict

param tags:

An array of user-defined keys and optional values that you can use to categorize and organize the core network endpoint.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'availableRegions': [
        'string',
    ],
    'coreNetworkArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'globalResolverId': 'string',
    'id': 'string',
    'ipAddresses': [
        {
            'ipv4Address': 'string',
            'ipv6Address': 'string',
            'dnsLabel': 'string',
            'dnsName': 'string',
            'regionScope': 'ALL'|'REGIONAL',
            'regions': [
                'string',
            ]
        },
    ],
    'name': 'string',
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the core network endpoint.

    • availableRegions (list) --

      The Amazon Web Services Regions in which the core network endpoint is available.

      • (string) --

    • coreNetworkArn (string) --

      The Amazon Resource Name (ARN) of the Amazon Web Services Cloud WAN core network connected to the endpoint.

    • createdAt (datetime) --

      The date and time when the core network endpoint was created.

    • globalResolverId (string) --

      The ID of the Route 53 Global Resolver associated with the core network endpoint.

    • id (string) --

      The unique identifier of the core network endpoint.

    • ipAddresses (list) --

      The IP addresses that the core network endpoint uses to resolve DNS queries within the Amazon Web Services Cloud WAN core network.

      • (dict) --

        A DNS IP address configuration returned for a core network endpoint. Each item describes an IP address that the endpoint uses to receive DNS queries, along with its DNS label and name, and the scope and Amazon Web Services Regions in which the address applies.

        • ipv4Address (string) --

          The IPv4 address that the core network endpoint uses to receive DNS queries.

        • ipv6Address (string) --

          The IPv6 address that the core network endpoint uses to receive DNS queries.

        • dnsLabel (string) --

          The DNS label associated with the IP address.

        • dnsName (string) --

          The fully qualified DNS name associated with the IP address.

        • regionScope (string) --

          Indicates whether the IP address applies to all Amazon Web Services Regions or only to the specific Regions that you identify. When the value is REGIONAL, the Regions are listed in the regions field.

        • regions (list) --

          The Amazon Web Services Regions in which the IP address applies when the region scope is REGIONAL.

          • (string) --

    • name (string) --

      The name of the core network endpoint.

    • status (string) --

      The current status of the core network endpoint.

    • updatedAt (datetime) --

      The date and time when the core network endpoint was last updated.

ListCoreNetworkEndpoints (new) Link ¶

Lists the core network endpoints in your Amazon Web Services account, with pagination support.

See also: AWS API Documentation

Request Syntax

client.list_core_network_endpoints(
    maxResults=123,
    nextToken='string',
    filters={
        'string': [
            'string',
        ]
    }
)
type maxResults:

integer

param maxResults:

The maximum number of results to retrieve in a single call.

type nextToken:

string

param nextToken:

A pagination token used for large sets of results that can't be returned in a single response.

type filters:

dict

param filters:

Values to filter the results.

  • (string) --

    • (list) --

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'coreNetworkEndpoints': [
        {
            'arn': 'string',
            'availableRegions': [
                'string',
            ],
            'coreNetworkArn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'globalResolverId': 'string',
            'id': 'string',
            'ipAddresses': [
                {
                    'ipv4Address': 'string',
                    'ipv6Address': 'string',
                    'dnsLabel': 'string',
                    'dnsName': 'string',
                    'regionScope': 'ALL'|'REGIONAL',
                    'regions': [
                        'string',
                    ]
                },
            ],
            'name': 'string',
            'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      A pagination token used for large sets of results that can't be returned in a single response. Provide this token in the next call to get the results not returned in this call.

    • coreNetworkEndpoints (list) --

      An array of information about the core network endpoints.

      • (dict) --

        Summary information about a core network endpoint. Route 53 Global Resolver returns one of these items for each endpoint in the response to a ListCoreNetworkEndpoints request. Each item describes the endpoint's identifiers, the Global Resolver and Cloud WAN core network that it connects, its DNS IP addresses, and its current status.

        • arn (string) --

          The Amazon Resource Name (ARN) of the core network endpoint.

        • availableRegions (list) --

          The Amazon Web Services Regions in which the core network endpoint is available.

          • (string) --

        • coreNetworkArn (string) --

          The Amazon Resource Name (ARN) of the Cloud WAN core network that the endpoint connects to.

        • createdAt (datetime) --

          The date and time when the core network endpoint was created.

        • globalResolverId (string) --

          The identifier of the Route 53 Global Resolver that the core network endpoint is associated with.

        • id (string) --

          The unique identifier of the core network endpoint.

        • ipAddresses (list) --

          The DNS IP addresses that the core network endpoint uses to receive DNS queries.

          • (dict) --

            A DNS IP address configuration returned for a core network endpoint. Each item describes an IP address that the endpoint uses to receive DNS queries, along with its DNS label and name, and the scope and Amazon Web Services Regions in which the address applies.

            • ipv4Address (string) --

              The IPv4 address that the core network endpoint uses to receive DNS queries.

            • ipv6Address (string) --

              The IPv6 address that the core network endpoint uses to receive DNS queries.

            • dnsLabel (string) --

              The DNS label associated with the IP address.

            • dnsName (string) --

              The fully qualified DNS name associated with the IP address.

            • regionScope (string) --

              Indicates whether the IP address applies to all Amazon Web Services Regions or only to the specific Regions that you identify. When the value is REGIONAL, the Regions are listed in the regions field.

            • regions (list) --

              The Amazon Web Services Regions in which the IP address applies when the region scope is REGIONAL.

              • (string) --

        • name (string) --

          The name of the core network endpoint.

        • status (string) --

          The current status of the core network endpoint.

        • updatedAt (datetime) --

          The date and time when the core network endpoint was last updated.

GetCoreNetworkEndpoint (new) Link ¶

Retrieves information about a core network endpoint.

See also: AWS API Documentation

Request Syntax

client.get_core_network_endpoint(
    coreNetworkEndpointId='string'
)
type coreNetworkEndpointId:

string

param coreNetworkEndpointId:

[REQUIRED]

The unique identifier of the core network endpoint to retrieve information about.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'availableRegions': [
        'string',
    ],
    'coreNetworkArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'globalResolverId': 'string',
    'id': 'string',
    'ipAddresses': [
        {
            'ipv4Address': 'string',
            'ipv6Address': 'string',
            'dnsLabel': 'string',
            'dnsName': 'string',
            'regionScope': 'ALL'|'REGIONAL',
            'regions': [
                'string',
            ]
        },
    ],
    'name': 'string',
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the core network endpoint.

    • availableRegions (list) --

      The Amazon Web Services Regions in which the core network endpoint is available.

      • (string) --

    • coreNetworkArn (string) --

      The Amazon Resource Name (ARN) of the Amazon Web Services Cloud WAN core network connected to the endpoint.

    • createdAt (datetime) --

      The date and time when the core network endpoint was created.

    • globalResolverId (string) --

      The ID of the Route 53 Global Resolver associated with the core network endpoint.

    • id (string) --

      The unique identifier of the core network endpoint.

    • ipAddresses (list) --

      The IP addresses that the core network endpoint uses to resolve DNS queries within the Amazon Web Services Cloud WAN core network.

      • (dict) --

        A DNS IP address configuration returned for a core network endpoint. Each item describes an IP address that the endpoint uses to receive DNS queries, along with its DNS label and name, and the scope and Amazon Web Services Regions in which the address applies.

        • ipv4Address (string) --

          The IPv4 address that the core network endpoint uses to receive DNS queries.

        • ipv6Address (string) --

          The IPv6 address that the core network endpoint uses to receive DNS queries.

        • dnsLabel (string) --

          The DNS label associated with the IP address.

        • dnsName (string) --

          The fully qualified DNS name associated with the IP address.

        • regionScope (string) --

          Indicates whether the IP address applies to all Amazon Web Services Regions or only to the specific Regions that you identify. When the value is REGIONAL, the Regions are listed in the regions field.

        • regions (list) --

          The Amazon Web Services Regions in which the IP address applies when the region scope is REGIONAL.

          • (string) --

    • name (string) --

      The name of the core network endpoint.

    • status (string) --

      The current status of the core network endpoint.

    • updatedAt (datetime) --

      The date and time when the core network endpoint was last updated.

UpdateCoreNetworkEndpoint (new) Link ¶

Updates the configuration of a core network endpoint. You can change the name and modify the IP addresses that the endpoint uses for DNS resolution.

See also: AWS API Documentation

Request Syntax

client.update_core_network_endpoint(
    coreNetworkEndpointId='string',
    name='string',
    updateIpAddresses=[
        {
            'operation': 'ADD'|'REMOVE'|'UPDATE',
            'ipv4Address': 'string',
            'ipv6Address': 'string',
            'dnsLabel': 'string',
            'regionScope': 'ALL'|'REGIONAL',
            'regions': [
                'string',
            ]
        },
    ]
)
type coreNetworkEndpointId:

string

param coreNetworkEndpointId:

[REQUIRED]

The unique identifier of the core network endpoint to update.

type name:

string

param name:

The name of the core network endpoint.

type updateIpAddresses:

list

param updateIpAddresses:

The IP address changes to apply to the core network endpoint. Use this parameter to add or remove the IP addresses that the endpoint uses to resolve DNS queries within the Amazon Web Services Cloud WAN core network.

  • (dict) --

    A single change to apply to the DNS IP addresses of a core network endpoint when you update it. Each entry specifies the operation to perform and the IP address details that the operation acts on.

    • operation (string) -- [REQUIRED]

      The operation to perform on the IP address. Valid values are ADD, REMOVE, and UPDATE.

    • ipv4Address (string) --

      The IPv4 address that the operation acts on.

    • ipv6Address (string) --

      The IPv6 address that the operation acts on.

    • dnsLabel (string) --

      The DNS label associated with the IP address.

    • regionScope (string) --

      Indicates whether the IP address applies to all Amazon Web Services Regions or only to the specific Regions that you identify. When the value is REGIONAL, the Regions are listed in the regions field.

    • regions (list) --

      The Amazon Web Services Regions in which the IP address applies when the region scope is REGIONAL.

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'availableRegions': [
        'string',
    ],
    'coreNetworkArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'globalResolverId': 'string',
    'id': 'string',
    'ipAddresses': [
        {
            'ipv4Address': 'string',
            'ipv6Address': 'string',
            'dnsLabel': 'string',
            'dnsName': 'string',
            'regionScope': 'ALL'|'REGIONAL',
            'regions': [
                'string',
            ]
        },
    ],
    'name': 'string',
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the updated core network endpoint.

    • availableRegions (list) --

      The Amazon Web Services Regions in which the updated core network endpoint is available.

      • (string) --

    • coreNetworkArn (string) --

      The Amazon Resource Name (ARN) of the Amazon Web Services Cloud WAN core network connected to the updated endpoint.

    • createdAt (datetime) --

      The date and time when the core network endpoint was originally created.

    • globalResolverId (string) --

      The ID of the Route 53 Global Resolver associated with the updated core network endpoint.

    • id (string) --

      The unique identifier of the updated core network endpoint.

    • ipAddresses (list) --

      The IP addresses that the updated core network endpoint uses to resolve DNS queries within the Amazon Web Services Cloud WAN core network.

      • (dict) --

        A DNS IP address configuration returned for a core network endpoint. Each item describes an IP address that the endpoint uses to receive DNS queries, along with its DNS label and name, and the scope and Amazon Web Services Regions in which the address applies.

        • ipv4Address (string) --

          The IPv4 address that the core network endpoint uses to receive DNS queries.

        • ipv6Address (string) --

          The IPv6 address that the core network endpoint uses to receive DNS queries.

        • dnsLabel (string) --

          The DNS label associated with the IP address.

        • dnsName (string) --

          The fully qualified DNS name associated with the IP address.

        • regionScope (string) --

          Indicates whether the IP address applies to all Amazon Web Services Regions or only to the specific Regions that you identify. When the value is REGIONAL, the Regions are listed in the regions field.

        • regions (list) --

          The Amazon Web Services Regions in which the IP address applies when the region scope is REGIONAL.

          • (string) --

    • name (string) --

      The name of the updated core network endpoint.

    • status (string) --

      The current status of the updated core network endpoint.

    • updatedAt (datetime) --

      The date and time when the core network endpoint was last updated.

DeleteCoreNetworkEndpoint (new) Link ¶

Deletes a core network endpoint. This operation cannot be undone.

See also: AWS API Documentation

Request Syntax

client.delete_core_network_endpoint(
    coreNetworkEndpointId='string'
)
type coreNetworkEndpointId:

string

param coreNetworkEndpointId:

[REQUIRED]

The unique identifier of the core network endpoint to delete.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'availableRegions': [
        'string',
    ],
    'coreNetworkArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'globalResolverId': 'string',
    'id': 'string',
    'ipAddresses': [
        {
            'ipv4Address': 'string',
            'ipv6Address': 'string',
            'dnsLabel': 'string',
            'dnsName': 'string',
            'regionScope': 'ALL'|'REGIONAL',
            'regions': [
                'string',
            ]
        },
    ],
    'name': 'string',
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the deleted core network endpoint.

    • availableRegions (list) --

      The Amazon Web Services Regions in which the deleted core network endpoint was available.

      • (string) --

    • coreNetworkArn (string) --

      The Amazon Resource Name (ARN) of the Amazon Web Services Cloud WAN core network that was connected to the deleted endpoint.

    • createdAt (datetime) --

      The date and time when the core network endpoint was originally created.

    • globalResolverId (string) --

      The ID of the Route 53 Global Resolver that was associated with the deleted core network endpoint.

    • id (string) --

      The unique identifier of the deleted core network endpoint.

    • ipAddresses (list) --

      The IP addresses that the deleted core network endpoint used to resolve DNS queries within the Amazon Web Services Cloud WAN core network.

      • (dict) --

        A DNS IP address configuration returned for a core network endpoint. Each item describes an IP address that the endpoint uses to receive DNS queries, along with its DNS label and name, and the scope and Amazon Web Services Regions in which the address applies.

        • ipv4Address (string) --

          The IPv4 address that the core network endpoint uses to receive DNS queries.

        • ipv6Address (string) --

          The IPv6 address that the core network endpoint uses to receive DNS queries.

        • dnsLabel (string) --

          The DNS label associated with the IP address.

        • dnsName (string) --

          The fully qualified DNS name associated with the IP address.

        • regionScope (string) --

          Indicates whether the IP address applies to all Amazon Web Services Regions or only to the specific Regions that you identify. When the value is REGIONAL, the Regions are listed in the regions field.

        • regions (list) --

          The Amazon Web Services Regions in which the IP address applies when the region scope is REGIONAL.

          • (string) --

    • name (string) --

      The name of the deleted core network endpoint.

    • status (string) --

      The final status of the deleted core network endpoint.

    • updatedAt (datetime) --

      The date and time when the core network endpoint was last updated before deletion.

CreateAccessSource (updated) Link ¶
Changes (both)
{'coreNetworkEndpointId': 'string',
 'ipAddressType': {'NONE'},
 'segment': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.create_access_source(
    cidr='string',
    clientToken='string',
    ipAddressType='IPV4'|'IPV6'|'NONE',
    name='string',
    coreNetworkEndpointId='string',
    segment='string',
    dnsViewId='string',
    protocol='DO53'|'DOH'|'DOT',
    tags={
        'string': 'string'
    }
)
type cidr:

string

param cidr:

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

type clientToken:

string

param clientToken:

A unique string that identifies the request and ensures idempotency.

This field is autopopulated if not provided.

type ipAddressType:

string

param ipAddressType:

The IP address type for this access source. Valid values are IPV4, IPV6, and NONE. If you provide a CIDR range, this defaults to IPV4; otherwise it defaults to NONE.

type name:

string

param name:

A descriptive name for the access source.

type coreNetworkEndpointId:

string

param coreNetworkEndpointId:

The ID of the core network endpoint to associate with this access source.

type segment:

string

param segment:

The name of the segment to associate with this access source.

type dnsViewId:

string

param dnsViewId:

[REQUIRED]

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

type protocol:

string

param protocol:

[REQUIRED]

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 tags:

dict

param tags:

Tags to associate with the access source.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'cidr': 'string',
    'createdAt': datetime(2015, 1, 1),
    'id': 'string',
    'ipAddressType': 'IPV4'|'IPV6'|'NONE',
    'coreNetworkEndpointId': 'string',
    'segment': 'string',
    'name': 'string',
    'dnsViewId': 'string',
    'protocol': 'DO53'|'DOH'|'DOT',
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the access source.

    • cidr (string) --

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

    • createdAt (datetime) --

      The date and time when the access source was created.

    • id (string) --

      The unique identifier for the access source.

    • ipAddressType (string) --

      The IP address type for this access source. Valid values are IPV4, IPV6, and NONE.

    • coreNetworkEndpointId (string) --

      The ID of the core network endpoint associated with this access source.

    • segment (string) --

      The name of the segment associated with this access source.

    • name (string) --

      The descriptive name of the access source.

    • dnsViewId (string) --

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

    • protocol (string) --

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

    • status (string) --

      The operational status of the access source.

    • updatedAt (datetime) --

      The date and time when the access source was last updated.

CreateGlobalResolver (updated) Link ¶
Changes (both)
{'publicIpStatus': 'ENABLED_RESERVED | DISABLED_RESERVED | DISABLED_RELEASED'}

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.

See also: AWS API Documentation

Request Syntax

client.create_global_resolver(
    clientToken='string',
    description='string',
    ipAddressType='IPV4'|'DUAL_STACK',
    publicIpStatus='ENABLED_RESERVED'|'DISABLED_RESERVED'|'DISABLED_RELEASED',
    name='string',
    observabilityRegion='string',
    regions=[
        'string',
    ],
    tags={
        'string': 'string'
    }
)
type clientToken:

string

param 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.

This field is autopopulated if not provided.

type description:

string

param description:

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

type ipAddressType:

string

param ipAddressType:

The IP address type for the Route 53 Global Resolver. Valid values are IPV4 (default) or DUAL_STACK for both IPv4 and IPv6 support.

type publicIpStatus:

string

param publicIpStatus:

Specifies the public IP connectivity to configure for the Route 53 Global Resolver. Public IP addresses let DNS clients send queries to the resolver over the internet. Valid values are the following:

  • ENABLED_RESERVED - Public IP connectivity is enabled, and the global anycast public IP addresses are reserved for the Route 53 Global Resolver.

  • DISABLED_RESERVED - Public IP connectivity is disabled, and the global anycast public IP addresses remain reserved for the Route 53 Global Resolver.

  • DISABLED_RELEASED - Public IP connectivity is disabled, and the global anycast public IP addresses are released.

type name:

string

param name:

[REQUIRED]

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

type observabilityRegion:

string

param observabilityRegion:

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

type regions:

list

param regions:

[REQUIRED]

List of Amazon Web Services 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.

  • (string) --

type tags:

dict

param tags:

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

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'clientToken': 'string',
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'dnsName': 'string',
    'ipAddressType': 'IPV4'|'DUAL_STACK',
    'publicIpStatus': 'ENABLED_RESERVED'|'DISABLED_RESERVED'|'DISABLED_RELEASED',
    'ipv4Addresses': [
        'string',
    ],
    'ipv6Addresses': [
        'string',
    ],
    'name': 'string',
    'observabilityRegion': 'string',
    'regions': [
        'string',
    ],
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • id (string) --

      The unique identifier for the Route 53 Global Resolver.

    • arn (string) --

      The Amazon Resource Name (ARN) of the Route 53 Global Resolver.

    • clientToken (string) --

      The unique string that identifies the request and ensures idempotency.

    • createdAt (datetime) --

      The date and time when the Route 53 Global Resolver was created.

    • description (string) --

      The description of the Route 53 Global Resolver.

    • dnsName (string) --

      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.

    • ipAddressType (string) --

      The IP address type configured for the Route 53 Global Resolver (IPV4 or DUAL_STACK).

    • publicIpStatus (string) --

      The public IP connectivity configured for the Route 53 Global Resolver. Public IP addresses let DNS clients send queries to the resolver over the internet. Valid values are the following:

      • ENABLED_RESERVED - Public IP connectivity is enabled, and the global anycast public IP addresses are reserved for the Route 53 Global Resolver.

      • DISABLED_RESERVED - Public IP connectivity is disabled, and the global anycast public IP addresses remain reserved for the Route 53 Global Resolver.

      • DISABLED_RELEASED - Public IP connectivity is disabled, and the global anycast public IP addresses are released.

    • ipv4Addresses (list) --

      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.

      • (string) --

    • ipv6Addresses (list) --

      The global anycast IPv6 addresses associated with the Route 53 Global Resolver. This field is only populated when ipAddressType is DUAL_STACK. DNS clients can send queries to these addresses from anywhere on the internet.

      • (string) --

    • name (string) --

      The name of the Route 53 Global Resolver.

    • observabilityRegion (string) --

      The Amazon Web Services Region where observability data for the Route 53 Global Resolver is stored.

    • regions (list) --

      The Amazon Web Services Regions where the Route 53 Global Resolver is deployed and operational.

      • (string) --

    • status (string) --

      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).

    • updatedAt (datetime) --

      The date and time when the Route 53 Global Resolver was last updated.

DeleteAccessSource (updated) Link ¶
Changes (response)
{'coreNetworkEndpointId': 'string',
 'ipAddressType': {'NONE'},
 'segment': 'string'}

Deletes an access source. This operation cannot be undone.

See also: AWS API Documentation

Request Syntax

client.delete_access_source(
    accessSourceId='string'
)
type accessSourceId:

string

param accessSourceId:

[REQUIRED]

The unique identifier of the access source to delete.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'cidr': 'string',
    'coreNetworkEndpointId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'id': 'string',
    'ipAddressType': 'IPV4'|'IPV6'|'NONE',
    'name': 'string',
    'dnsViewId': 'string',
    'protocol': 'DO53'|'DOH'|'DOT',
    'segment': 'string',
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the deleted access source.

    • cidr (string) --

      The IP address or CIDR range of the deleted access source.

    • coreNetworkEndpointId (string) --

      The ID of the core network endpoint associated with this access source.

    • createdAt (datetime) --

      The date and time when the access source was originally created.

    • id (string) --

      The unique identifier of the deleted access source.

    • ipAddressType (string) --

      The IP address type of the deleted access source. Valid values are IPV4, IPV6, and NONE.

    • name (string) --

      The name of the deleted access source.

    • dnsViewId (string) --

      The ID of the DNS view that was associated with the deleted access source.

    • protocol (string) --

      The DNS protocol that was permitted for the deleted access source.

    • segment (string) --

      The name of the segment associated with this access source.

    • status (string) --

      The final status of the deleted access source.

    • updatedAt (datetime) --

      The date and time when the access source was last updated before deletion.

GetAccessSource (updated) Link ¶
Changes (response)
{'coreNetworkEndpointId': 'string',
 'ipAddressType': {'NONE'},
 'segment': 'string'}

Retrieves information about an access source.

See also: AWS API Documentation

Request Syntax

client.get_access_source(
    accessSourceId='string'
)
type accessSourceId:

string

param accessSourceId:

[REQUIRED]

The unique identifier of the access source to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'cidr': 'string',
    'coreNetworkEndpointId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'id': 'string',
    'ipAddressType': 'IPV4'|'IPV6'|'NONE',
    'name': 'string',
    'dnsViewId': 'string',
    'protocol': 'DO53'|'DOH'|'DOT',
    'segment': 'string',
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the access source.

    • cidr (string) --

      The IP range for the rule's parameters in CIDR notation.

    • coreNetworkEndpointId (string) --

      The ID of the core network endpoint associated with this access source.

    • createdAt (datetime) --

      The time and date the rule was created.

    • id (string) --

      ID for the rule.

    • ipAddressType (string) --

      The IP address type.

    • name (string) --

      Name for the access source.

    • dnsViewId (string) --

      ID for the DNS view that the rule is associated to.

    • protocol (string) --

      The protocol determines how data is transmitted to a Global Resolver instance.

    • segment (string) --

      The name of the segment associated with this access source.

    • status (string) --

      Information about the status of the rule.

    • updatedAt (datetime) --

      The time and date the access source was updated.

GetGlobalResolver (updated) Link ¶
Changes (response)
{'publicIpStatus': 'ENABLED_RESERVED | DISABLED_RESERVED | DISABLED_RELEASED'}

Retrieves information about a Route 53 Global Resolver instance.

See also: AWS API Documentation

Request Syntax

client.get_global_resolver(
    globalResolverId='string'
)
type globalResolverId:

string

param globalResolverId:

[REQUIRED]

The ID of the Route 53 Global Resolver to retrieve information about.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'clientToken': 'string',
    'dnsName': 'string',
    'observabilityRegion': 'string',
    'name': 'string',
    'description': 'string',
    'regions': [
        'string',
    ],
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'ipv4Addresses': [
        'string',
    ],
    'ipv6Addresses': [
        'string',
    ],
    'ipAddressType': 'IPV4'|'DUAL_STACK',
    'publicIpStatus': 'ENABLED_RESERVED'|'DISABLED_RESERVED'|'DISABLED_RELEASED'
}

Response Structure

  • (dict) --

    • id (string) --

      The ID of the Global Resolver.

    • arn (string) --

      The Amazon Resource Name (ARN) of the Global Resolver.

    • clientToken (string) --

      A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same clientToken has the same result every time.

    • dnsName (string) --

      The hostname used by the customers' DNS clients for certification validation.

    • observabilityRegion (string) --

      The Amazon Web Services Regions in which the users' Global Resolver query resolution logs will be propagated.

    • name (string) --

      The name of the Global Resolver.

    • description (string) --

      The description of the Global Resolver.

    • regions (list) --

      The Amazon Web Services Regions in which the Global Resolver operate.

      • (string) --

    • createdAt (datetime) --

      The date and time the Global Resolver was created.

    • updatedAt (datetime) --

      The date and time the Global Resolver was updated.

    • status (string) --

      The operational status of the Global Resolver.

    • ipv4Addresses (list) --

      List of anycast IPv4 addresses associated with the Global Resolver instance.

      • (string) --

    • ipv6Addresses (list) --

      List of anycast IPv6 addresses associated with the Global Resolver instance. This field is only populated when ipAddressType is DUAL_STACK.

      • (string) --

    • ipAddressType (string) --

      The IP address type configured for the Global Resolver.

    • publicIpStatus (string) --

      The public IP connectivity configured for the Route 53 Global Resolver. Public IP addresses let DNS clients send queries to the resolver over the internet. Valid values are the following:

      • ENABLED_RESERVED - Public IP connectivity is enabled, and the global anycast public IP addresses are reserved for the Route 53 Global Resolver.

      • DISABLED_RESERVED - Public IP connectivity is disabled, and the global anycast public IP addresses remain reserved for the Route 53 Global Resolver.

      • DISABLED_RELEASED - Public IP connectivity is disabled, and the global anycast public IP addresses are released.

ListAccessSources (updated) Link ¶
Changes (response)
{'accessSources': {'coreNetworkEndpointId': 'string',
                   'ipAddressType': {'NONE'},
                   'segment': 'string'}}

Lists all access sources with pagination support.

See also: AWS API Documentation

Request Syntax

client.list_access_sources(
    maxResults=123,
    nextToken='string',
    filters={
        'string': [
            'string',
        ]
    }
)
type maxResults:

integer

param maxResults:

The maximum number of results to retrieve in a single call.

type nextToken:

string

param nextToken:

A pagination token used for large sets of results that can't be returned in a single response.

type filters:

dict

param filters:

Values to filter the results.

  • (string) --

    • (list) --

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'accessSources': [
        {
            'arn': 'string',
            'cidr': 'string',
            'coreNetworkEndpointId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'id': 'string',
            'ipAddressType': 'IPV4'|'IPV6'|'NONE',
            'name': 'string',
            'dnsViewId': 'string',
            'protocol': 'DO53'|'DOH'|'DOT',
            'segment': 'string',
            'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      A pagination token used for large sets of results that can't be returned in a single response. Provide this token in the next call to get the results not returned in this call.

    • accessSources (list) --

      An array containing information about the access sources, such as the ID and CIDR.

      • (dict) --

        Summary information about an access source.

        • arn (string) --

          The Amazon Resource Name (ARN) of the access source.

        • cidr (string) --

          The CIDR block that defines the IP address range for the access source.

        • coreNetworkEndpointId (string) --

          The ID of the core network endpoint associated with this access source.

        • createdAt (datetime) --

          The date and time when the access source was created.

        • id (string) --

          The unique identifier of the access source.

        • ipAddressType (string) --

          The IP address type of the access source.

        • name (string) --

          The name of the access source.

        • dnsViewId (string) --

          The ID of the DNS view that the access source is associated with.

        • protocol (string) --

          The protocol used by the access source.

        • segment (string) --

          The name of the segment associated with this access source.

        • status (string) --

          The current status of the access source.

        • updatedAt (datetime) --

          The date and time when the access source was last updated.

ListGlobalResolvers (updated) Link ¶
Changes (response)
{'globalResolvers': {'publicIpStatus': 'ENABLED_RESERVED | DISABLED_RESERVED | '
                                       'DISABLED_RELEASED'}}

Lists all Route 53 Global Resolver instances in your account with pagination support.

See also: AWS API Documentation

Request Syntax

client.list_global_resolvers(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of Route 53 Global Resolver instances to return in the response. Valid range is 1-100.

type nextToken:

string

param nextToken:

The token for the next page of results. This value is returned in the response if there are more results to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'globalResolvers': [
        {
            'id': 'string',
            'arn': 'string',
            'clientToken': 'string',
            'dnsName': 'string',
            'observabilityRegion': 'string',
            'name': 'string',
            'description': 'string',
            'regions': [
                'string',
            ],
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
            'ipv4Addresses': [
                'string',
            ],
            'ipv6Addresses': [
                'string',
            ],
            'ipAddressType': 'IPV4'|'DUAL_STACK',
            'publicIpStatus': 'ENABLED_RESERVED'|'DISABLED_RESERVED'|'DISABLED_RELEASED'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      A pagination token used for large sets of results that can't be returned in a single response. Provide this token in the next call to get the results not returned in this call.

    • globalResolvers (list) --

      Paginated list of Global Resolvers.

      • (dict) --

        Summary information about a global resolver.

        • id (string) --

          The unique identifier of the global resolver.

        • arn (string) --

          The Amazon Resource Name (ARN) of the global resolver.

        • clientToken (string) --

          The unique string that identifies the request and ensures idempotency.

        • dnsName (string) --

          The DNS name of the global resolver.

        • observabilityRegion (string) --

          The Amazon Web Services Region where observability data is collected for the global resolver.

        • name (string) --

          The name of the global resolver.

        • description (string) --

          A description of the global resolver.

        • regions (list) --

          The Amazon Web Services Regions where the global resolver is deployed.

          • (string) --

        • createdAt (datetime) --

          The date and time when the global resolver was created.

        • updatedAt (datetime) --

          The date and time when the global resolver was last updated.

        • status (string) --

          The current status of the global resolver.

        • ipv4Addresses (list) --

          The IPv4 addresses assigned to the global resolver.

          • (string) --

        • ipv6Addresses (list) --

          The IPv6 addresses assigned to the global resolver. This field is only populated when ipAddressType is DUAL_STACK.

          • (string) --

        • ipAddressType (string) --

          The IP address type configured for the global resolver.

        • publicIpStatus (string) --

          The public IP connectivity configured for the Route 53 Global Resolver. Public IP addresses let DNS clients send queries to the resolver over the internet. Valid values are the following:

          • ENABLED_RESERVED - Public IP connectivity is enabled, and the global anycast public IP addresses are reserved for the Route 53 Global Resolver.

          • DISABLED_RESERVED - Public IP connectivity is disabled, and the global anycast public IP addresses remain reserved for the Route 53 Global Resolver.

          • DISABLED_RELEASED - Public IP connectivity is disabled, and the global anycast public IP addresses are released.

UpdateAccessSource (updated) Link ¶
Changes (request, response)
Request
{'dnsViewId': 'string', 'ipAddressType': {'NONE'}}
Response
{'coreNetworkEndpointId': 'string',
 'ipAddressType': {'NONE'},
 'segment': 'string'}

Updates the configuration of an access source.

See also: AWS API Documentation

Request Syntax

client.update_access_source(
    accessSourceId='string',
    cidr='string',
    dnsViewId='string',
    ipAddressType='IPV4'|'IPV6'|'NONE',
    name='string',
    protocol='DO53'|'DOH'|'DOT'
)
type accessSourceId:

string

param accessSourceId:

[REQUIRED]

The unique identifier of the access source to update.

type cidr:

string

param cidr:

The CIDR block for the access source.

type dnsViewId:

string

param dnsViewId:

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

type ipAddressType:

string

param ipAddressType:

The IP address type for the access source.

type name:

string

param name:

The name of the access source.

type protocol:

string

param protocol:

The protocol for the access source.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'cidr': 'string',
    'coreNetworkEndpointId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'id': 'string',
    'ipAddressType': 'IPV4'|'IPV6'|'NONE',
    'name': 'string',
    'dnsViewId': 'string',
    'protocol': 'DO53'|'DOH'|'DOT',
    'segment': 'string',
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the updated access source.

    • cidr (string) --

      The CIDR block of the updated access source.

    • coreNetworkEndpointId (string) --

      The ID of the core network endpoint associated with this access source.

    • createdAt (datetime) --

      The date and time when the access source was originally created.

    • id (string) --

      The unique identifier of the updated access source.

    • ipAddressType (string) --

      The IP address type of the updated access source.

    • name (string) --

      The name of the updated access source.

    • dnsViewId (string) --

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

    • protocol (string) --

      The protocol of the updated access source.

    • segment (string) --

      The name of the segment associated with this access source.

    • status (string) --

      The current status of the updated access source.

    • updatedAt (datetime) --

      The date and time when the access source was last updated.

UpdateGlobalResolver (updated) Link ¶
Changes (both)
{'publicIpStatus': 'ENABLED_RESERVED | DISABLED_RESERVED | DISABLED_RELEASED'}

Updates the configuration of a Route 53 Global Resolver instance. You can modify the name, description, and observability Region.

See also: AWS API Documentation

Request Syntax

client.update_global_resolver(
    globalResolverId='string',
    name='string',
    observabilityRegion='string',
    description='string',
    ipAddressType='IPV4'|'DUAL_STACK',
    publicIpStatus='ENABLED_RESERVED'|'DISABLED_RESERVED'|'DISABLED_RELEASED',
    regions=[
        'string',
    ]
)
type globalResolverId:

string

param globalResolverId:

[REQUIRED]

The ID of the Global Resolver.

type name:

string

param name:

The name of the Global Resolver.

type observabilityRegion:

string

param observabilityRegion:

The Amazon Web Services Regions in which the users' Global Resolver query resolution logs will be propagated.

type description:

string

param description:

The description of the Global Resolver.

type ipAddressType:

string

param ipAddressType:

The IP address type for the Global Resolver. Valid values are IPV4 or DUAL_STACK for both IPv4 and IPv6 support.

type publicIpStatus:

string

param publicIpStatus:

Specifies the public IP connectivity to configure for the Route 53 Global Resolver. Public IP addresses let DNS clients send queries to the resolver over the internet. Valid values are the following:

  • ENABLED_RESERVED - Public IP connectivity is enabled, and the global anycast public IP addresses are reserved for the Route 53 Global Resolver.

  • DISABLED_RESERVED - Public IP connectivity is disabled, and the global anycast public IP addresses remain reserved for the Route 53 Global Resolver.

  • DISABLED_RELEASED - Public IP connectivity is disabled, and the global anycast public IP addresses are released.

type regions:

list

param regions:

The list of Amazon Web Services Regions where the Global Resolver will operate. The resolver will be distributed across these Regions to provide global availability and low-latency DNS resolution.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'clientToken': 'string',
    'dnsName': 'string',
    'observabilityRegion': 'string',
    'name': 'string',
    'description': 'string',
    'regions': [
        'string',
    ],
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
    'ipv4Addresses': [
        'string',
    ],
    'ipv6Addresses': [
        'string',
    ],
    'ipAddressType': 'IPV4'|'DUAL_STACK',
    'publicIpStatus': 'ENABLED_RESERVED'|'DISABLED_RESERVED'|'DISABLED_RELEASED'
}

Response Structure

  • (dict) --

    • id (string) --

      The ID of the Global Resolver.

    • arn (string) --

      The Amazon Resource Name (ARN) of the Global Resolver.

    • clientToken (string) --

      A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same clientToken has the same result every time.

    • dnsName (string) --

      The hostname to be used by the customers' DNS clients for certification validation.

    • observabilityRegion (string) --

      The Amazon Web Services Regions in which the users' Global Resolver query resolution logs will be propagated.

    • name (string) --

      Name of the Global Resolver.

    • description (string) --

      Description of the Global Resolver.

    • regions (list) --

      The Amazon Web Services Regions in which the Global Resolver will operate.

      • (string) --

    • createdAt (datetime) --

      The time and date the Global Resolverwas created.

    • updatedAt (datetime) --

      The time and date the Global Resolver was updated.

    • status (string) --

      The operational status of the Global Resolver.

    • ipv4Addresses (list) --

      List of anycast IPv4 addresses associated with the Global Resolver instance.

      • (string) --

    • ipv6Addresses (list) --

      List of anycast IPv6 addresses associated with the updated Global Resolver instance. This field is only populated when ipAddressType is DUAL_STACK.

      • (string) --

    • ipAddressType (string) --

      The IP address type configured for the updated Global Resolver.

    • publicIpStatus (string) --

      The public IP connectivity configured for the Route 53 Global Resolver. Public IP addresses let DNS clients send queries to the resolver over the internet. Valid values are the following:

      • ENABLED_RESERVED - Public IP connectivity is enabled, and the global anycast public IP addresses are reserved for the Route 53 Global Resolver.

      • DISABLED_RESERVED - Public IP connectivity is disabled, and the global anycast public IP addresses remain reserved for the Route 53 Global Resolver.

      • DISABLED_RELEASED - Public IP connectivity is disabled, and the global anycast public IP addresses are released.