Skip to content

AssociateCustomDomainRequest

Source code in docs_src/capo_apprunner/types/associate_custom_domain_request.py
class AssociateCustomDomainRequest(TypedDict, closed=True):
    service_arn: "capo_apprunner.types.app_runner_resource_arn.AppRunnerResourceArn"
    """<p>The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.</p>"""
    domain_name: "capo_apprunner.types.domain_name.DomainName"
    """<p>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>).</p>"""
    enable_www_subdomain: NotRequired[
        "capo_apprunner.types.nullable_boolean.NullableBoolean"
    ]
    """<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>"""

domain_name instance-attribute

domain_name: DomainName

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

enable_www_subdomain instance-attribute

enable_www_subdomain: NotRequired[NullableBoolean]

Set to true to associate the subdomain www.DomainName with the App Runner service in addition to the base domain.

Default: true

service_arn instance-attribute

service_arn: AppRunnerResourceArn

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