AWS::AppSync::DomainNameApiAssociation - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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

AWS::AppSync::DomainNameApiAssociation

The AWS::AppSync::DomainNameApiAssociation resource represents the mapping of your custom domain name to the assigned API URL.

Syntax

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

JSON

{
  "Type" : "AWS::AppSync::DomainNameApiAssociation",
  "Properties" : {
      "ApiId" : String,
      "DomainName" : String
    }
}

YAML

Type: AWS::AppSync::DomainNameApiAssociation
Properties:
  ApiId: String
  DomainName: String

Properties

ApiId

The API ID.

Required: Yes

Type: String

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