AWS::AppSync::DomainName - Amazon CloudFormation
SyntaxPropertiesReturn values
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).

AWS::AppSync::DomainName

The AWS::AppSync::DomainName resource creates a DomainNameConfig object to configure a custom domain.

Syntax

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

JSON

{
  "Type" : "AWS::AppSync::DomainName",
  "Properties" : {
      "CertificateArn" : String,
      "Description" : String,
      "DomainName" : String
    }
}

YAML

Type: AWS::AppSync::DomainName
Properties:
  CertificateArn: String
  Description: String
  DomainName: String

Properties

CertificateArn

The Amazon Resource Name (ARN) of the certificate. This will be an Amazon Certificate Manager certificate.

Required: Yes

Type: String

Pattern: ^arn:[a-z-]*:acm:[a-z0-9-]*:\d{12}:certificate/[0-9A-Za-z_/-]*$

Minimum: 3

Maximum: 2048

Update requires: Replacement

Description

The decription for your domain name.

Required: No

Type: String

Minimum: 0

Maximum: 255

Update requires: No interruption

DomainName

The domain name.

Required: Yes

Type: String

Pattern: ^(\*[a-z\d-]*\.)?([a-z\d-]+\.)+[a-z\d-]+$

Minimum: 1

Maximum: 253

Update requires: Replacement

Return values

Ref

When you pass the logical ID of an AWS::AppSync::DomainName resource to the intrinsic Ref function, the function returns the domain name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using Fn::GetAtt, see Fn::GetAtt.

AppSyncDomainName

The domain name provided by Amazon AppSync.

DomainName

The domain name.

HostedZoneId

The ID of your Amazon Route 53 hosted zone.