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,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::AppSync::DomainName
Properties:
CertificateArn: String
Description: String
DomainName: String
Tags:
- Tag
Properties
CertificateArn-
The Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.
Required: Yes
Type: String
Pattern:
^arn:[a-z-]*:acm:[a-z0-9-]*:\d{12}:certificate/[0-9A-Za-z_/-]*$Minimum:
3Maximum:
2048Update requires: Replacement
Description-
The decription for your domain name.
Required: No
Type: String
Minimum:
0Maximum:
255Update requires: No interruption
DomainName-
The domain name.
Required: Yes
Type: String
Pattern:
^(\*[a-z\d-]*\.)?([a-z\d-]+\.)+[a-z\d-]+$Minimum:
1Maximum:
253Update requires: Replacement
-
A set of tags (key-value pairs) for this domain name.
Required: No
Type: Array of Tag
Update requires: No interruption
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-
The domain name.
DomainNameArn-
The Amazon resource name (ARN) of the domain name.
HostedZoneId-
The ID of your Amazon Route 53 hosted zone.
