Class KafkaSchemaRegistryAccessConfigType

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.lambda.KafkaSchemaRegistryAccessConfigType
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-09T14:39:13.597Z") @Stability(Stable) public class KafkaSchemaRegistryAccessConfigType extends software.amazon.jsii.JsiiObject
The type of authentication protocol for your schema registry.

Example:

 import software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource;
 import software.amazon.awscdk.services.lambda.eventsources.ConfluentSchemaRegistry;
 import software.amazon.awscdk.services.secretsmanager.Secret;
 // Your MSK cluster arn
 String clusterArn;
 Function myFunction;
 // The Kafka topic you want to subscribe to
 String topic = "some-cool-topic";
 Secret secret = Secret.Builder.create(this, "Secret").secretName("AmazonMSK_KafkaSecret").build();
 myFunction.addEventSource(ManagedKafkaEventSource.Builder.create()
         .clusterArn(clusterArn)
         .topic(topic)
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .provisionedPollerConfig(ProvisionedPollerConfig.builder()
                 .minimumPollers(1)
                 .maximumPollers(3)
                 .build())
         .schemaRegistryConfig(ConfluentSchemaRegistry.Builder.create()
                 .schemaRegistryUri("https://example.com")
                 .eventRecordFormat(EventRecordFormat.JSON)
                 .authenticationType(KafkaSchemaRegistryAccessConfigType.BASIC_AUTH)
                 .secret(secret)
                 .schemaValidationConfigs(List.of(KafkaSchemaValidationConfig.builder().attribute(KafkaSchemaValidationAttribute.KEY).build()))
                 .build())
         .build());
 
  • Field Details

    • BASIC_AUTH

      @Stability(Stable) public static final KafkaSchemaRegistryAccessConfigType BASIC_AUTH
      The Secrets Manager secret that stores your broker credentials.
    • CLIENT_CERTIFICATE_TLS_AUTH

      @Stability(Stable) public static final KafkaSchemaRegistryAccessConfigType CLIENT_CERTIFICATE_TLS_AUTH
      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.
    • SASL_SCRAM_256_AUTH

      @Stability(Stable) public static final KafkaSchemaRegistryAccessConfigType SASL_SCRAM_256_AUTH
      The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed broker.
    • SASL_SCRAM_512_AUTH

      @Stability(Stable) public static final KafkaSchemaRegistryAccessConfigType SASL_SCRAM_512_AUTH
      The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed broker.
    • SERVER_ROOT_CA_CERTIFICATE

      @Stability(Stable) public static final KafkaSchemaRegistryAccessConfigType SERVER_ROOT_CA_CERTIFICATE
      The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your schema registry.
    • VIRTUAL_HOST

      @Stability(Stable) public static final KafkaSchemaRegistryAccessConfigType VIRTUAL_HOST
      The name of the virtual host in your schema registry.

      Lambda uses this broker host as the event source.

    • VPC_SECURITY_GROUP

      @Stability(Stable) public static final KafkaSchemaRegistryAccessConfigType VPC_SECURITY_GROUP
      The VPC security group used to manage access to your self-managed brokers.
    • VPC_SUBNET

      @Stability(Stable) public static final KafkaSchemaRegistryAccessConfigType VPC_SUBNET
      The subnets associated with your VPC.

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

  • Constructor Details

    • KafkaSchemaRegistryAccessConfigType

      protected KafkaSchemaRegistryAccessConfigType(software.amazon.jsii.JsiiObjectRef objRef)
    • KafkaSchemaRegistryAccessConfigType

      protected KafkaSchemaRegistryAccessConfigType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
  • Method Details

    • of

      @Stability(Stable) @NotNull public static KafkaSchemaRegistryAccessConfigType of(@NotNull String name)
      A custom source access configuration property for schema registry.

      Parameters:
      name - This parameter is required.
    • getType

      @Stability(Stable) @NotNull public String getType()
      The key to use in SchemaRegistryConfig.AccessConfig.Type property in CloudFormation.