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