AWS::Amplify::Domain

Specifies the AWS::Amplify::Domain resource that enables 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,
      "CertificateSettings" : CertificateSettings,
      "DomainName" : String,
      "EnableAutoSubDomain" : Boolean,
      "SubDomainSettings" : [ SubDomainSetting, ... ]
    }
}

YAML

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

Properties

AppId

The unique ID for an Amplify app.

Required: Yes

Type: String

Pattern: d[a-z0-9]+

Minimum: 1

Maximum: 20

Update requires: Replacement

AutoSubDomainCreationPatterns

Sets the branch patterns for automatic subdomain creation.

Required: No

Type: Array of String

Minimum: 1

Maximum: 2048

Update requires: No interruption

AutoSubDomainIAMRole

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

Required: No

Type: String

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

Maximum: 1000

Update requires: No interruption

CertificateSettings

The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

Required: No

Type: CertificateSettings

Update requires: No interruption

DomainName

The domain name for the domain association.

Required: Yes

Type: String

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

Maximum: 255

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: Array of SubDomainSetting

Maximum: 255

Update requires: No interruption

Return values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see 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.

UpdateStatus

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

REQUESTING_CERTIFICATE

The certificate is in the process of being updated.

PENDING_VERIFICATION

Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

IMPORTING_CUSTOM_CERTIFICATE

Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

PENDING_DEPLOYMENT

Indicates that the subdomain or certificate changes are being propagated.

AWAITING_APP_CNAME

Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

UPDATE_COMPLETE

The certificate has been associated with a domain.

UPDATE_FAILED

The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.