aws-cdk-lib.aws_lambda.CfnEventSourceMapping.SchemaRegistryConfigProperty

SchemaRegistryConfigProperty Struct

Specific configuration settings for a Kafka schema registry.

Source

Generated code

Type last changed

v2.201.0 · 13 Jun 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const schemaRegistryConfigProperty: lambda.CfnEventSourceMapping.SchemaRegistryConfigProperty = {
  accessConfigs: [{
    type: 'type',
    uri: 'uri',
  }],
  eventRecordFormat: 'eventRecordFormat',
  schemaRegistryUri: 'schemaRegistryUri',
  schemaValidationConfigs: [{
    attribute: 'attribute',
  }],
};

# 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_

schema_registry_config_property = lambda.CfnEventSourceMapping.SchemaRegistryConfigProperty(
    access_configs=[lambda.CfnEventSourceMapping.SchemaRegistryAccessConfigProperty(
        type="type",
        uri="uri"
    )],
    event_record_format="eventRecordFormat",
    schema_registry_uri="schemaRegistryUri",
    schema_validation_configs=[lambda.CfnEventSourceMapping.SchemaValidationConfigProperty(
        attribute="attribute"
    )]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lambda.*;

SchemaRegistryConfigProperty schemaRegistryConfigProperty = SchemaRegistryConfigProperty.builder()
        .accessConfigs(List.of(SchemaRegistryAccessConfigProperty.builder()
                .type("type")
                .uri("uri")
                .build()))
        .eventRecordFormat("eventRecordFormat")
        .schemaRegistryUri("schemaRegistryUri")
        .schemaValidationConfigs(List.of(SchemaValidationConfigProperty.builder()
                .attribute("attribute")
                .build()))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;

var schemaRegistryConfigProperty = new SchemaRegistryConfigProperty {
    AccessConfigs = new [] { new SchemaRegistryAccessConfigProperty {
        Type = "type",
        Uri = "uri"
    } },
    EventRecordFormat = "eventRecordFormat",
    SchemaRegistryUri = "schemaRegistryUri",
    SchemaValidationConfigs = new [] { new SchemaValidationConfigProperty {
        Attribute = "attribute"
    } }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

schemaRegistryConfigProperty := &SchemaRegistryConfigProperty{
	AccessConfigs: []interface{}{
		&SchemaRegistryAccessConfigProperty{
			Type: jsii.String("type"),
			Uri: jsii.String("uri"),
		},
	},
	EventRecordFormat: jsii.String("eventRecordFormat"),
	SchemaRegistryUri: jsii.String("schemaRegistryUri"),
	SchemaValidationConfigs: []interface{}{
		&SchemaValidationConfigProperty{
			Attribute: jsii.String("attribute"),
		},
	},
}

Properties

accessConfigs?optionalIResolvable | IResolvable | CfnEventSourceMapping.SchemaRegistryAccessConfigProperty[]access_configs?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SchemaRegistryAccessConfigProperty]]]accessConfigs?optionalIResolvableAccessConfigs?optionalIResolvableAccessConfigs?optionalinterface{}#

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

eventRecordFormat?optionalstringevent_record_format?optionalstreventRecordFormat?optionalStringEventRecordFormat?optionalstringEventRecordFormat?optional*string#

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

notes

• 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.

schemaRegistryUri?optionalstringschema_registry_uri?optionalstrschemaRegistryUri?optionalStringSchemaRegistryUri?optionalstringSchemaRegistryUri?optional*string#

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

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

schemaValidationConfigs?optionalIResolvable | IResolvable | CfnEventSourceMapping.SchemaValidationConfigProperty[]schema_validation_configs?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SchemaValidationConfigProperty]]]schemaValidationConfigs?optionalIResolvableSchemaValidationConfigs?optionalIResolvableSchemaValidationConfigs?optionalinterface{}#

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