Skip to content

Lambda  >  Structures  >  KafkaSchemaRegistryConfig

KafkaSchemaRegistryConfig

Structure Class

KafkaSchemaRegistryConfig dataclass

Specific configuration settings for a Kafka schema registry.

Attributes

access_configs class-attribute instance-attribute 
access_configs: list[KafkaSchemaRegistryAccessConfig] | None = None

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

event_record_format class-attribute instance-attribute 
event_record_format: SchemaRegistryEventRecordFormat | None = None

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 class-attribute instance-attribute 
schema_registry_uri: str | None = None

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 class-attribute instance-attribute 
schema_validation_configs: list[KafkaSchemaValidationConfig] | None = None

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