class KafkaSchemaRegistryAccessConfigType

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.KafkaSchemaRegistryAccessConfigType
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslambda#KafkaSchemaRegistryAccessConfigType
Java	software.amazon.awscdk.services.lambda.KafkaSchemaRegistryAccessConfigType
Python	aws_cdk.aws_lambda.KafkaSchemaRegistryAccessConfigType
TypeScript (source)	aws-cdk-lib » aws_lambda » KafkaSchemaRegistryAccessConfigType

The type of authentication protocol for your schema registry.

Example

import { ManagedKafkaEventSource, ConfluentSchemaRegistry } from 'aws-cdk-lib/aws-lambda-event-sources';
import { Secret } from 'aws-cdk-lib/aws-secretsmanager';

// Your MSK cluster arn
declare const clusterArn: string;

// The Kafka topic you want to subscribe to
const topic = 'some-cool-topic';

const secret = new Secret(this, 'Secret', { secretName: 'AmazonMSK_KafkaSecret' });

declare const myFunction: lambda.Function;
myFunction.addEventSource(new ManagedKafkaEventSource({
  clusterArn,
  topic,
  startingPosition: lambda.StartingPosition.TRIM_HORIZON,
  provisionedPollerConfig: {
    minimumPollers: 1,
    maximumPollers: 3,
  },
  schemaRegistryConfig: new ConfluentSchemaRegistry({
    schemaRegistryUri: 'https://example.com',
    eventRecordFormat: lambda.EventRecordFormat.JSON,
    authenticationType: lambda.KafkaSchemaRegistryAccessConfigType.BASIC_AUTH,
    secret: secret,
    schemaValidationConfigs: [{ attribute: lambda.KafkaSchemaValidationAttribute.KEY }],
  }),
}));

Properties

Name	Type	Description
type	string	The key to use in SchemaRegistryConfig.AccessConfig.Type property in CloudFormation.
static BASIC_AUTH	KafkaSchemaRegistryAccessConfigType	The Secrets Manager secret that stores your broker credentials.
static CLIENT_CERTIFICATE_TLS_AUTH	KafkaSchemaRegistryAccessConfigType	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 of your schema registry.
static SASL_SCRAM_256_AUTH	KafkaSchemaRegistryAccessConfigType	The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed broker.
static SASL_SCRAM_512_AUTH	KafkaSchemaRegistryAccessConfigType	The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed broker.
static SERVER_ROOT_CA_CERTIFICATE	KafkaSchemaRegistryAccessConfigType	The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your schema registry.
static VIRTUAL_HOST	KafkaSchemaRegistryAccessConfigType	The name of the virtual host in your schema registry.
static VPC_SECURITY_GROUP	KafkaSchemaRegistryAccessConfigType	The VPC security group used to manage access to your self-managed brokers.
static VPC_SUBNET	KafkaSchemaRegistryAccessConfigType	The subnets associated with your VPC.

---

type

Type: string

The key to use in SchemaRegistryConfig.AccessConfig.Type property in CloudFormation.

---

static BASIC_AUTH

Type: KafkaSchemaRegistryAccessConfigType

The Secrets Manager secret that stores your broker credentials.

---

static CLIENT_CERTIFICATE_TLS_AUTH

Type: KafkaSchemaRegistryAccessConfigType

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 of your schema registry.

---

static SASL_SCRAM_256_AUTH

Type: KafkaSchemaRegistryAccessConfigType

The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed broker.

---

static SASL_SCRAM_512_AUTH

Type: KafkaSchemaRegistryAccessConfigType

The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed broker.

---

static SERVER_ROOT_CA_CERTIFICATE

Type: KafkaSchemaRegistryAccessConfigType

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

---

static VIRTUAL_HOST

Type: KafkaSchemaRegistryAccessConfigType

The name of the virtual host in your schema registry.

Lambda uses this broker host as the event source.

---

static VPC_SECURITY_GROUP

Type: KafkaSchemaRegistryAccessConfigType

The VPC security group used to manage access to your self-managed brokers.

---

static VPC_SUBNET

Type: KafkaSchemaRegistryAccessConfigType

The subnets associated with your VPC.

Lambda connects to these subnets to fetch data from your self-managed cluster.

Methods

Name	Description
static of(name)	A custom source access configuration property for schema registry.

---

static of(name)

public static of(name: string): KafkaSchemaRegistryAccessConfigType

Parameters

• name string

Returns

• KafkaSchemaRegistryAccessConfigType

A custom source access configuration property for schema registry.