Associate Custom Domain
apprunner_associate_custom_domain | R Documentation |
Associate your own domain name with the App Runner subdomain URL of your App Runner service¶
Description¶
Associate your own domain name with the App Runner subdomain URL of your App Runner service.
After you call associate_custom_domain
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).
Usage¶
Arguments¶
ServiceArn
[required] The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.
DomainName
[required] A custom domain endpoint to associate. Specify a root domain (for example,
example.com
), a subdomain (for example,login.example.com
oradmin.login.example.com
), or a wildcard (for example,*.example.com
).EnableWWWSubdomain
Set to
true
to associate the subdomainwww.DomainName
with the App Runner service in addition to the base domain.Default:
true
Value¶
A list with the following syntax:
list(
DNSTarget = "string",
ServiceArn = "string",
CustomDomain = list(
DomainName = "string",
EnableWWWSubdomain = TRUE|FALSE,
CertificateValidationRecords = list(
list(
Name = "string",
Type = "string",
Value = "string",
Status = "PENDING_VALIDATION"|"SUCCESS"|"FAILED"
)
),
Status = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"DELETING"|"DELETE_FAILED"|"PENDING_CERTIFICATE_DNS_VALIDATION"|"BINDING_CERTIFICATE"
),
VpcDNSTargets = list(
list(
VpcIngressConnectionArn = "string",
VpcId = "string",
DomainName = "string"
)
)
)