DomainNameConfiguration ¶

class DomainNameConfiguration(TypedDict, closed=True):
    api_gateway_domain_name: NotRequired["capo_apigatewayv2.types.__string.__string"]
    """<p>A domain name for the API.</p>"""
    certificate_arn: NotRequired["capo_apigatewayv2.types.arn.Arn"]
    """<p>An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>"""
    certificate_name: NotRequired[
        "capo_apigatewayv2.types.string_with_length_between1_and128.StringWithLengthBetween1And128"
    ]
    """<p>The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.</p>"""
    certificate_upload_date: NotRequired[
        "capo_apigatewayv2.types.__timestamp_iso8601.__timestampIso8601"
    ]
    """<p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>"""
    domain_name_status: NotRequired[
        "capo_apigatewayv2.types.domain_name_status.DomainNameStatus"
    ]
    """<p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>"""
    domain_name_status_message: NotRequired["capo_apigatewayv2.types.__string.__string"]
    """<p>An optional text message containing detailed information about status of the domain name migration.</p>"""
    endpoint_type: NotRequired["capo_apigatewayv2.types.endpoint_type.EndpointType"]
    """<p>The endpoint type.</p>"""
    hosted_zone_id: NotRequired["capo_apigatewayv2.types.__string.__string"]
    """<p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>"""
    ip_address_type: NotRequired[
        "capo_apigatewayv2.types.ip_address_type.IpAddressType"
    ]
    """<p>The IP address types that can invoke the domain name. Use ipv4 to allow only IPv4 addresses to invoke your domain name, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your domain name.</p>"""
    security_policy: NotRequired[
        "capo_apigatewayv2.types.security_policy.SecurityPolicy"
    ]
    """<p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>"""
    ownership_verification_certificate_arn: NotRequired[
        "capo_apigatewayv2.types.arn.Arn"
    ]
    """<p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>"""