AWS::AppSync::DomainName

AppSync DomainName

Resource Type definition for AWS::AppSync::DomainName

Properties

4 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`CertificateArn`	`string`	RequiredCreate-only
`DomainName`	`string`	RequiredCreate-only
`Description`	`string`
`Tags`	`array`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AppSyncDomainName`	`string`	-
`DomainNameArn`	`string`	The Amazon Resource Name (ARN) for the Domain Name.
`HostedZoneId`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::AppSync::DomainName

Resources:
  MyResource:
    Type: AWS::AppSync::DomainName
    Properties:
      DomainName: "my-domainname"
      CertificateArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

appsync:CreateDomainNameappsync:GetDomainNameacm:DescribeCertificatecloudfront:UpdateDistributionappsync:TagResource

delete

appsync:GetDomainNameappsync:DeleteDomainNameappsync:UntagResource

update

appsync:UpdateDomainNameappsync:TagResourceappsync:UntagResourceappsync:GetDomainName

read

appsync:GetDomainName

list

appsync:ListDomainNames

Get the AppSync Cheat Sheet

Everything you need to know about AppSync on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceAppSync

Properties7

Required2

TaggingSupported

Primary IDDomainName

Supported Operations

CreateDeleteUpdateReadList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DomainNameCertificateArn

Related Resources

External Links

AWS Documentation