POST /apps/{appId}/domains/{domainName}
Creates a new domain association for an Amplify app.
Servers
- https://amplify.{region}.amazonaws.com
- https://amplify.{region}.amazonaws.com.cn
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
appId |
String | Yes |
The unique ID for an Amplify app. |
domainName |
String | Yes |
The name of the domain. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
X-Amz-Content-Sha256 |
String | No | |
X-Amz-Credential |
String | No | |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-Amz-Date |
String | No | |
X-Amz-Algorithm |
String | No | |
X-Amz-SignedHeaders |
String | No | |
X-Amz-Security-Token |
String | No | |
X-Amz-Signature |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
autoSubDomainIAMRole |
String | No |
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. |
enableAutoSubDomain |
Boolean | No |
Enables the automated creation of subdomains for branches. |
autoSubDomainCreationPatterns[] |
Array | No |
Sets the branch patterns for automatic subdomain creation. |
subDomainSettings[] |
Array | No |
Describes the settings for the subdomain. |
subDomainSettings[].prefix |
String | Yes |
The prefix setting for the subdomain. |
subDomainSettings[].branchName |
String | Yes |
The branch name setting for the subdomain. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.