AWS::Route53GlobalResolver::AccessToken - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Route53GlobalResolver::AccessToken

Creates an access token for a DNS view. Access tokens provide token-based authentication for DNS-over-HTTPS (DoH) and DNS-over-TLS (DoT) connections to the Route 53 Global Resolver.

Important

Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon CLI commands.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Route53GlobalResolver::AccessToken", "Properties" : { "ClientToken" : String, "DnsViewId" : String, "ExpiresAt" : String, "Name" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::Route53GlobalResolver::AccessToken Properties: ClientToken: String DnsViewId: String ExpiresAt: String Name: String Tags: - Tag

Properties

ClientToken

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.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

DnsViewId

The ID of the DNS view associated with the token.

Required: Yes

Type: String

Minimum: 1

Maximum: 64

Update requires: Replacement

ExpiresAt

The date and time when the token expires.

Required: No

Type: String

Update requires: Replacement

Name

The name of the token.

Required: No

Type: String

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

Minimum: 1

Maximum: 64

Update requires: No interruption

Tags

An array of user-defined keys and optional values. These tags can be used for categorization and organization.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

AccessTokenId

The unique identifier for the access token.

Arn

The Amazon Resource Name (ARN) of the token.

CreatedAt

The date and time when the token was created.

GlobalResolverId

The ID of the global resolver associated with the token.

Status

The current status of the token.

UpdatedAt

The date and time when the token was last updated.

Value

The access token value. This token should be included in DoH and DoT requests for authentication. Keep this value secure as it provides access to your Route 53 Global Resolver.