Skip to content

KafkaSchemaRegistryAccessConfig

Source code in docs_src/capo_lambda/types/kafka_schema_registry_access_config.py 
12
13
14
15
16
17
18
class KafkaSchemaRegistryAccessConfig(TypedDict, closed=True):
    type: NotRequired[
        "capo_lambda.types.kafka_schema_registry_auth_type.KafkaSchemaRegistryAuthType"
    ]
    """<p> The type of authentication Lambda uses to access your schema registry. </p> <ul> <li> <p> <code>BASIC_AUTH</code> – The Secrets Manager ARN of your secret key used for basic authentication with your Confluent schema registry.</p> </li> <li> <p> <code>CLIENT_CERTIFICATE_TLS_AUTH</code> – The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication with your Confluent schema registry.</p> </li> <li> <p> <code>SERVER_ROOT_CA_CERTIFICATE</code> – The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption with your Confluent schema registry.</p> </li> <li> <p> <code>OAUTHBEARER_AUTH</code> – The Secrets Manager ARN of your secret key containing the OAuth 2.0 credentials that Lambda uses to acquire an access token for your Confluent schema registry. For the contents of the secret, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/kafka-cluster-auth.html#smaa-auth-oauth-secret">Configuring the OAuth secret</a>.</p> </li> </ul>"""
    uri: NotRequired["capo_lambda.types.arn.Arn"]
    """<p> The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry. </p>"""

type instance-attribute 

type: NotRequired[KafkaSchemaRegistryAuthType]

The type of authentication Lambda uses to access your schema registry.

  • BASIC_AUTH – The Secrets Manager ARN of your secret key used for basic authentication with your Confluent schema registry.

  • CLIENT_CERTIFICATE_TLS_AUTH – The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication with your Confluent schema registry.

  • SERVER_ROOT_CA_CERTIFICATE – The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption with your Confluent schema registry.

  • OAUTHBEARER_AUTH – The Secrets Manager ARN of your secret key containing the OAuth 2.0 credentials that Lambda uses to acquire an access token for your Confluent schema registry. For the contents of the secret, see Configuring the OAuth secret.

uri instance-attribute 

uri: NotRequired[Arn]

The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.