DomainDescriptionType ¶

class DomainDescriptionType(TypedDict, closed=True):
    user_pool_id: NotRequired[
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    ]
    """<p>The ID of the user pool that the domain is attached to.</p>"""
    aws_account_id: NotRequired[
        "capo_cognito_identity_provider.types.aws_account_id_type.AWSAccountIdType"
    ]
    """<p>The Amazon Web Services account that you created the user pool in.</p>"""
    domain: NotRequired["capo_cognito_identity_provider.types.domain_type.DomainType"]
    """<p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>"""
    s3_bucket: NotRequired[
        "capo_cognito_identity_provider.types.s3_bucket_type.S3BucketType"
    ]
    """<p>The Amazon S3 bucket where the static files for this domain are stored.</p>"""
    cloud_front_distribution: NotRequired[
        "capo_cognito_identity_provider.types.string_type.StringType"
    ]
    """<p>The Amazon CloudFront endpoint that hosts your custom domain.</p>"""
    version: NotRequired[
        "capo_cognito_identity_provider.types.domain_version_type.DomainVersionType"
    ]
    """<p>The app version.</p>"""
    status: NotRequired[
        "capo_cognito_identity_provider.types.domain_status_type.DomainStatusType"
    ]
    """<p>The domain status.</p>"""
    custom_domain_config: NotRequired[
        "capo_cognito_identity_provider.types.custom_domain_config_type.CustomDomainConfigType"
    ]
    """<p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.</p>"""
    managed_login_version: NotRequired[
        "capo_cognito_identity_provider.types.wrapped_integer_type.WrappedIntegerType"
    ]
    """<p>The version of managed login branding that you want to apply to your domain. A value of <code>1</code> indicates hosted UI (classic) branding and a version of <code>2</code> indicates managed login branding.</p> <p>Managed login requires that your user pool be configured for any <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html">feature plan</a> other than <code>Lite</code>.</p>"""
    routing: NotRequired[
        "capo_cognito_identity_provider.types.routing_type.RoutingType"
    ]
    """<p>The routing configuration for the domain, including failover settings for multi-region deployments. Currently only <code>Failover</code> configurations are allowed.</p>"""