DomainAssociation
Describes a domain association that associates a custom domain with an Amplify app.
Contents
- 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
- certificateVerificationDNSRecord
-
The DNS record for certificate verification.
Type: String
Length Constraints: Maximum length of 1000.
Required: No
- 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
Valid Values:
PENDING_VERIFICATION | IN_PROGRESS | AVAILABLE | PENDING_DEPLOYMENT | FAILED | CREATING | REQUESTING_CERTIFICATE | UPDATINGRequired: Yes
- enableAutoSubDomain
-
Enables the automated creation of subdomains for branches.
Type: Boolean
Required: Yes
- statusReason
-
The reason for the current status of the domain association.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
