Skip to content

CreateDomainAssociationRequest

Source code in docs_src/capo_amplify/types/create_domain_association_request.py
class CreateDomainAssociationRequest(TypedDict, closed=True):
    app_id: "capo_amplify.types.app_id.AppId"
    """<p> The unique ID for an Amplify app. </p>"""
    domain_name: "capo_amplify.types.domain_name.DomainName"
    """<p> The domain name for the domain association. </p>"""
    enable_auto_sub_domain: NotRequired[
        "capo_amplify.types.enable_auto_sub_domain.EnableAutoSubDomain"
    ]
    """<p> Enables the automated creation of subdomains for branches. </p>"""
    sub_domain_settings: "capo_amplify.types.sub_domain_settings.SubDomainSettings"
    """<p> The setting for the subdomain. </p>"""
    auto_sub_domain_creation_patterns: NotRequired[
        "capo_amplify.types.auto_sub_domain_creation_patterns.AutoSubDomainCreationPatterns"
    ]
    """<p> Sets the branch patterns for automatic subdomain creation. </p>"""
    auto_sub_domain_iam_role: NotRequired[
        "capo_amplify.types.auto_sub_domain_iam_role.AutoSubDomainIAMRole"
    ]
    """<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>"""
    certificate_settings: NotRequired[
        "capo_amplify.types.certificate_settings.CertificateSettings"
    ]
    """<p>The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.</p>"""

app_id instance-attribute

app_id: AppId

The unique ID for an Amplify app.

auto_sub_domain_creation_patterns instance-attribute

auto_sub_domain_creation_patterns: NotRequired[AutoSubDomainCreationPatterns]

Sets the branch patterns for automatic subdomain creation.

auto_sub_domain_iam_role instance-attribute

auto_sub_domain_iam_role: NotRequired[AutoSubDomainIAMRole]

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

certificate_settings instance-attribute

certificate_settings: NotRequired[CertificateSettings]

The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

domain_name instance-attribute

domain_name: DomainName

The domain name for the domain association.

enable_auto_sub_domain instance-attribute

enable_auto_sub_domain: NotRequired[EnableAutoSubDomain]

Enables the automated creation of subdomains for branches.

sub_domain_settings instance-attribute

sub_domain_settings: SubDomainSettings

The setting for the subdomain.