Skip to content

KafkaSchemaRegistryConfig

Source code in docs_src/capo_lambda/types/kafka_schema_registry_config.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class KafkaSchemaRegistryConfig(TypedDict, closed=True):
    schema_registry_uri: NotRequired[
        "capo_lambda.types.schema_registry_uri.SchemaRegistryUri"
    ]
    """<p>The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.</p> <ul> <li> <p>For Glue schema registries, use the ARN of the registry.</p> </li> <li> <p>For Confluent schema registries, use the URL of the registry.</p> </li> </ul>"""
    event_record_format: NotRequired[
        "capo_lambda.types.schema_registry_event_record_format.SchemaRegistryEventRecordFormat"
    ]
    """<p>The record format that Lambda delivers to your function after schema validation.</p> <ul> <li> <p>Choose <code>JSON</code> to have Lambda deliver the record to your function as a standard JSON object.</p> </li> <li> <p>Choose <code>SOURCE</code> to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.</p> </li> </ul>"""
    access_configs: NotRequired[
        "capo_lambda.types.kafka_schema_registry_access_config_list.KafkaSchemaRegistryAccessConfigList"
    ]
    """<p>An array of access configuration objects that tell Lambda how to authenticate with your schema registry.</p>"""
    schema_validation_configs: NotRequired[
        "capo_lambda.types.kafka_schema_validation_config_list.KafkaSchemaValidationConfigList"
    ]
    """<p>An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.</p>"""

access_configs instance-attribute 

access_configs: NotRequired[KafkaSchemaRegistryAccessConfigList]

An array of access configuration objects that tell Lambda how to authenticate with your schema registry.

event_record_format instance-attribute 

event_record_format: NotRequired[SchemaRegistryEventRecordFormat]

The record format that Lambda delivers to your function after schema validation.

  • Choose JSON to have Lambda deliver the record to your function as a standard JSON object.

  • Choose SOURCE to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.

schema_registry_uri instance-attribute 

schema_registry_uri: NotRequired[SchemaRegistryUri]

The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.

  • For Glue schema registries, use the ARN of the registry.

  • For Confluent schema registries, use the URL of the registry.

schema_validation_configs instance-attribute 

schema_validation_configs: NotRequired[KafkaSchemaValidationConfigList]

An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.