v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1435184159.4 KB

Associate your own domain name with the App Runner subdomain URL of your App Runner service.

After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks domain validity in a certificate stored in AWS Certificate Manager (ACM).

post/#X-Amz-Target=AppRunner.AssociateCustomDomain

Headers

X-Amz-Target'AppRunner.AssociateCustomDomain' required

Request body

ServiceArnstring required

The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

DomainNamestring required

A custom domain endpoint to associate. Specify a root domain (for example, <code>example.com</code>), a subdomain (for example, <code>login.example.com</code> or <code>admin.login.example.com</code>), or a wildcard (for example, <code>*.example.com</code>).

EnableWWWSubdomainboolean
<p>Set to <code>true</code> to associate the subdomain <code>www.<i>DomainName</i> </code> with the App Runner service in addition to the base domain.</p> <p>Default: <code>true</code> </p>

Response

Success

DNSTargetstring required

The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.

ServiceArnstring required

The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.