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.112.0 (build de1bc80)", date="2025-06-20T13:49:19.206Z") @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());
 
  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    The Secrets Manager secret that stores your broker credentials.
    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.
    The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your schema registry.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    KafkaSchemaRegistryAccessConfigType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    KafkaSchemaRegistryAccessConfigType(software.amazon.jsii.JsiiObjectRef objRef)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    The key to use in SchemaRegistryConfig.AccessConfig.Type property in CloudFormation.
    of(String name)
    A custom source access configuration property for schema registry.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • 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.
    • 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.
  • 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.