AWS::AppSync::DomainName - AWS CloudFormation

AWS::AppSync::DomainName

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

Syntax

To declare this entity in your AWS 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 AWS Certificate Manager certificate.

Required: Yes

Type: String

Update requires: Replacement

Description

The decription for your domain name.

Required: No

Type: String

Update requires: No interruption

DomainName

The domain name.

Required: Yes

Type: String

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 AWS AppSync.

DomainName

Not currently supported by AWS CloudFormation.

HostedZoneId

The ID of your Amazon RouteĀ 53 hosted zone.