Skip to content

MutualTlsAuthentication

Source code in docs_src/capo_api_gateway/types/mutual_tls_authentication.py 
12
13
14
15
16
17
18
19
20
class MutualTlsAuthentication(TypedDict, closed=True):
    truststore_uri: NotRequired["capo_api_gateway.types.string.String"]
    """<p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example <code>s3://bucket-name/key-name</code>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>"""
    truststore_version: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>"""
    truststore_warnings: NotRequired[
        "capo_api_gateway.types.list_of_string.ListOfString"
    ]
    """<p>A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.</p>"""

truststore_uri instance-attribute 

truststore_uri: NotRequired[String]

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

truststore_version instance-attribute 

truststore_version: NotRequired[String]

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

truststore_warnings instance-attribute 

truststore_warnings: NotRequired[ListOfString]

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.