Amazon WorkMail · JSON Structure

Workmail Domain Structure

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.

Type: object Properties: 2
Business CommunicationCalendarEmailExchangeEnterprise

Domain is a JSON Structure definition published by Amazon WorkMail, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

DomainName HostedZoneId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "DomainName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainName"
        },
        {
          "description": "The fully qualified domain name."
        }
      ]
    },
    "HostedZoneId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HostedZoneId"
        },
        {
          "description": "The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53."
        }
      ]
    }
  },
  "description": "<p>The domain to associate with an WorkMail organization.</p> <p>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 <a href=\"https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html\">Adding a domain</a> in the <i>WorkMail Administrator Guide</i>.</p>",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "Domain",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-domain-structure.json"
}