KafkaSchemaRegistryConfig

class aws_cdk.aws_lambda.KafkaSchemaRegistryConfig(*, event_record_format, schema_registry_uri, schema_validation_configs, access_configs=None)

Bases: object

(Amazon MSK and self-managed Apache Kafka only) Specific configuration settings for a Kafka schema registry.

Parameters:

  • event_record_format (EventRecordFormat) – 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. Default: - none

  • schema_registry_uri (str) – The URI for your schema registry. The correct URI format depends on the type of schema registry you’re using. Default: - none

  • schema_validation_configs (Sequence[Union[KafkaSchemaValidationConfig, Dict[str, Any]]]) – An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry. Default: - none

  • access_configs (Optional[Sequence[Union[KafkaSchemaRegistryAccessConfig, Dict[str, Any]]]]) – An array of access configuration objects that tell Lambda how to authenticate with your schema registry. Default: - none

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lambda as lambda_

# event_record_format: lambda.EventRecordFormat
# kafka_schema_registry_access_config_type: lambda.KafkaSchemaRegistryAccessConfigType
# kafka_schema_validation_attribute: lambda.KafkaSchemaValidationAttribute

kafka_schema_registry_config = lambda.KafkaSchemaRegistryConfig(
    event_record_format=event_record_format,
    schema_registry_uri="schemaRegistryUri",
    schema_validation_configs=[lambda.KafkaSchemaValidationConfig(
        attribute=kafka_schema_validation_attribute
    )],

    # the properties below are optional
    access_configs=[lambda.KafkaSchemaRegistryAccessConfig(
        type=kafka_schema_registry_access_config_type,
        uri="uri"
    )]
)

Attributes

access_configs

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

Default:

  • none

event_record_format

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.

Default:

  • none

schema_registry_uri

The URI for your schema registry.

The correct URI format depends on the type of schema registry you’re using.

Default:

  • none

schema_validation_configs

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

Default:

  • none