custom_domains

Creates, updates, deletes, gets or lists a custom_domains resource.

Overview

Name	custom_domains
Type	Resource
Id	aws.apprunner.custom_domains

Fields

The following fields are returned by SELECT queries:

describe_custom_domains

Name	Datatype	Description
custom_domains	array	A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to MaxResults records per call.
dns_target	string	The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name. (pattern: <code>.*</code>)
next_token	string	The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request. (pattern: <code>.*</code>)
service_arn	string	The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe. (pattern: <code>arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011}</code>)
vpc_dns_targets	array	DNS Target records for the custom domains of this Amazon VPC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_custom_domains	select	region		Return a description of custom domain names that are associated with an App Runner service.
associate_custom_domain	update	region, ServiceArn, DomainName		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).
disassociate_custom_domain	exec	region, ServiceArn, DomainName		Disassociate a custom domain name from an App Runner service. Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_custom_domains

Return a description of custom domain names that are associated with an App Runner service.

SELECT
custom_domains,
dns_target,
next_token,
service_arn,
vpc_dns_targets
FROM aws.apprunner.custom_domains
WHERE region = '{{ region }}' -- required
;

UPDATE examples

associate_custom_domain

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).

UPDATE aws.apprunner.custom_domains
SET 
ServiceArn = '{{ ServiceArn }}',
DomainName = '{{ DomainName }}',
EnableWWWSubdomain = {{ EnableWWWSubdomain }}
WHERE 
region = '{{ region }}' --required
AND ServiceArn = '{{ ServiceArn }}' --required
AND DomainName = '{{ DomainName }}' --required
RETURNING
custom_domain,
dns_target,
service_arn,
vpc_dns_targets;

Lifecycle Methods

disassociate_custom_domain

Disassociate a custom domain name from an App Runner service. Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.

EXEC aws.apprunner.custom_domains.disassociate_custom_domain 
@region='{{ region }}' --required 
@@json=
'{
"ServiceArn": "{{ ServiceArn }}", 
"DomainName": "{{ DomainName }}"
}'
;