Domain
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
The domain to associate with an WorkMail organization.
When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide.
Contents
- DomainName
-
The fully qualified domain name.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9.-]+Required: Yes
- HostedZoneId
-
The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[^/\\]*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
