AWS Fundamentals Logo
AWS Fundamentals
AWS::Amplify::Domain

Amplify Domain

The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.

Properties

7 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
AppId
string
RequiredCreate-only
DomainName
string
RequiredCreate-only
SubDomainSettings
Array<SubDomainSetting>
Required
AutoSubDomainCreationPatterns
Array<string>
AutoSubDomainIAMRole
string
CertificateSettings
CertificateSettings
Write-only
EnableAutoSubDomain
boolean

Return Values

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

AttributeTypeDescription
Arnstring-
CertificateCertificate-
CertificateRecordstring-
DomainStatusstring-
StatusReasonstring-
UpdateStatusstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Amplify::Domain

Resources:
  MyResource:
    Type: AWS::Amplify::Domain
    Properties:
      AppId: "my-appid"
      DomainName: "my-domainname"
      SubDomainSettings: []

Required IAM Permissions

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

create

amplify:GetDomainAssociationamplify:CreateDomainAssociationroute53:ListHostedZonesroute53:ChangeResourceRecordSetsiam:PassRoleamplify:TagResource

delete

amplify:GetDomainAssociationamplify:DeleteDomainAssociationroute53:ListHostedZonesiam:PassRole

list

amplify:ListDomainAssociationsiam:PassRoleamplify:ListTagsForResource

read

amplify:GetDomainAssociationroute53:ListHostedZonesiam:PassRoleamplify:ListTagsForResource

update

amplify:GetDomainAssociationamplify:UpdateDomainAssociationroute53:ListHostedZonesroute53:ChangeResourceRecordSetsiam:PassRoleamplify:ListTagsForResourceamplify:TagResourceamplify:UntagResource

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceAmplify
Properties13
Required3
TaggingNot supported
Primary IDArn

Supported Operations

CreateDeleteListReadUpdate

Immutable After Creation

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

AppIdDomainName

Related Resources

External Links