DomainAssociation

Describes the association between a custom domain and an Amplify app.

domainAssociationArn

The Amazon Resource Name (ARN) for the domain association.

Type: String

Length Constraints: Maximum length of 1000.

Required: Yes

domainName

The name of the domain.

Type: String

Length Constraints: Maximum length of 64.

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

Required: Yes

domainStatus

The current status of the domain association.

Type: String

Required: Yes

enableAutoSubDomain

Enables the automated creation of subdomains for branches.

Type: Boolean

Required: Yes

statusReason

Additional information that describes why the domain association is in the current state.

Type: String

Length Constraints: Maximum length of 1000.

Required: Yes

subDomains

The subdomains for the domain association.

Type: Array of SubDomain objects

Array Members: Maximum number of 500 items.

Required: Yes

autoSubDomainCreationPatterns

Sets branch patterns for automatic subdomain creation.

Type: Array of strings

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

Pattern: (?s).+

Required: No

autoSubDomainIAMRole

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

Type: String

Length Constraints: Maximum length of 1000.

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

Required: No

certificate

Describes 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.

Type: Certificate object

Required: No

certificateVerificationDNSRecord

The DNS record for certificate verification.

Type: String

Length Constraints: Maximum length of 1000.

Required: No

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.

Type: String

Required: No

DomainAssociation

Contents

See Also