Amplify Domain Association

Amplify Domain Association in AWS links a custom domain to an Amplify app, enabling users to access the app through their own domain names. It manages domain settings, subdomains, and SSL certificates, simplifying the process of connecting and securing web applications hosted on AWS Amplify.

aws.amplify_domain_association

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
auto_sub_domain_creation_patternscorearray<string>Sets branch patterns for automatic subdomain creation.
auto_sub_domain_iam_rolecorestringThe required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
certificatecorejsonDescribes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you. If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.
certificate_verification_dns_recordcorestringThe DNS record for certificate verification.
domain_association_arncorestringThe Amazon Resource Name (ARN) for the domain association.
domain_namecorestringThe name of the domain.
domain_statuscorestringThe current status of the domain association.
enable_auto_sub_domaincoreboolEnables the automated creation of subdomains for branches.
status_reasoncorestringAdditional information that describes why the domain association is in the current state.
sub_domainscorejsonThe subdomains for the domain association.
tagscorehstore
update_statuscorestringThe 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.