AWS::Amplify::Domain

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

Syntax

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

JSON

{
  "Type" : "AWS::Amplify::Domain",
  "Properties" : {
      "AppId" : String,
      "AutoSubDomainCreationPatterns" : [ String, ... ],
      "AutoSubDomainIAMRole" : String,
      "DomainName" : String,
      "EnableAutoSubDomain" : Boolean,
      "SubDomainSettings" : [ SubDomainSetting, ... ]
    }
}

YAML

Type: AWS::Amplify::Domain
Properties: 
  AppId: String
  AutoSubDomainCreationPatterns: 
    - String
  AutoSubDomainIAMRole: String
  DomainName: String
  EnableAutoSubDomain: Boolean
  SubDomainSettings: 
    - SubDomainSetting

Properties

AppId

The unique ID for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: d[a-z0-9]+

Required: Yes

Type: String

Update requires: Replacement

AutoSubDomainCreationPatterns

Sets the branch patterns for automatic subdomain creation.

Required: No

Type: List of String

Update requires: No interruption

AutoSubDomainIAMRole

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

Length Constraints: Maximum length of 1000.

Pattern: ^$|^arn:aws:iam::\d{12}:role.+

Required: No

Type: String

Update requires: No interruption

DomainName

The domain name for the domain association.

Length Constraints: Maximum length of 255.

Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\.)?$

Required: Yes

Type: String

Update requires: Replacement

EnableAutoSubDomain

Enables the automated creation of subdomains for branches.

Required: No

Type: Boolean

Update requires: No interruption

SubDomainSettings

The setting for the subdomain.

Required: Yes

Type: List of SubDomainSetting

Update requires: No interruption

Return values

Fn::GetAtt

Arn

ARN for the Domain Association.

AutoSubDomainCreationPatterns

Branch patterns for the automatically created subdomain.

AutoSubDomainIAMRole

The IAM service role for the subdomain.

CertificateRecord

DNS Record for certificate verification.

DomainName

Name of the domain.

DomainStatus

Status for the Domain Association.

EnableAutoSubDomain

Specifies whether the automated creation of subdomains for branches is enabled.

StatusReason

Reason for the current status of the domain.