POST

/apps/{appId}/domains

http://amplify.{region}.amazonaws.com/apps/{appId}/domains

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

Access Token Required: API Key

Path Parameters

appIdstringrequired

The unique ID for an Amplify app.

Body Params

domainNamestringrequired

The domain name for the domain association.

subDomainSettingsarrayrequired

The setting for the subdomain.

enableAutoSubDomainboolean

Enables the automated creation of subdomains for branches.

autoSubDomainIAMRolestring

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

autoSubDomainCreationPatternsarray

Sets the branch patterns for automatic subdomain creation.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://amplify.{region}.amazonaws.com/apps/{appId}/domains' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}