DomainAssociation ¶

class DomainAssociation(TypedDict, closed=True):
    domain_association_arn: (
        "capo_amplify.types.domain_association_arn.DomainAssociationArn"
    )
    """<p> The Amazon Resource Name (ARN) for the domain association. </p>"""
    domain_name: "capo_amplify.types.domain_name.DomainName"
    """<p> The name of the domain. </p>"""
    enable_auto_sub_domain: (
        "capo_amplify.types.enable_auto_sub_domain.EnableAutoSubDomain"
    )
    """<p> Enables the automated creation of subdomains for branches. </p>"""
    auto_sub_domain_creation_patterns: NotRequired[
        "capo_amplify.types.auto_sub_domain_creation_patterns.AutoSubDomainCreationPatterns"
    ]
    """<p> Sets 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>"""
    domain_status: "capo_amplify.types.domain_status.DomainStatus"
    """<p> The current status of the domain association. </p>"""
    update_status: NotRequired["capo_amplify.types.update_status.UpdateStatus"]
    """<p>The status of the domain update operation that is currently in progress. The following list describes the valid update states.</p> <dl> <dt>REQUESTING_CERTIFICATE</dt> <dd> <p>The certificate is in the process of being updated.</p> </dd> <dt>PENDING_VERIFICATION</dt> <dd> <p>Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.</p> </dd> <dt>IMPORTING_CUSTOM_CERTIFICATE</dt> <dd> <p>Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.</p> </dd> <dt>PENDING_DEPLOYMENT</dt> <dd> <p>Indicates that the subdomain or certificate changes are being propagated.</p> </dd> <dt>AWAITING_APP_CNAME</dt> <dd> <p>Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html">Setting up custom domains</a> in the <i>Amplify Hosting User Guide</i>. </p> </dd> <dt>UPDATE_COMPLETE</dt> <dd> <p>The certificate has been associated with a domain.</p> </dd> <dt>UPDATE_FAILED</dt> <dd> <p>The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.</p> </dd> </dl>"""
    status_reason: "capo_amplify.types.status_reason.StatusReason"
    """<p> Additional information that describes why the domain association is in the current state.</p>"""
    certificate_verification_dns_record: NotRequired[
        "capo_amplify.types.certificate_verification_dns_record.CertificateVerificationDNSRecord"
    ]
    """<p> The DNS record for certificate verification. </p>"""
    sub_domains: "capo_amplify.types.sub_domains.SubDomains"
    """<p> The subdomains for the domain association. </p>"""
    certificate: NotRequired["capo_amplify.types.certificate.Certificate"]
    """<p>Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.</p> <p>If you are updating your domain to use a different certificate, <code>certificate</code> points to the new certificate that is being created instead of the current active certificate. Otherwise, <code>certificate</code> points to the current active certificate.</p>"""