Class KafkaSchemaRegistryAccessConfig

java.lang.Object
software.amazon.awssdk.services.lambda.model.KafkaSchemaRegistryAccessConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KafkaSchemaRegistryAccessConfig.Builder,KafkaSchemaRegistryAccessConfig>
@Generated("software.amazon.awssdk:codegen") public final class KafkaSchemaRegistryAccessConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KafkaSchemaRegistryAccessConfig.Builder,KafkaSchemaRegistryAccessConfig>

Specific access configuration settings that tell Lambda how to authenticate with your schema registry.

If you're working with an Glue schema registry, don't provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.

If you're working with a Confluent schema registry, choose the authentication method in the Type field, and provide the Secrets Manager secret ARN in the URI field.

See Also:

  • Method Details

    • type

      public final KafkaSchemaRegistryAuthType type()

      The type of authentication Lambda uses to access your schema registry.

      • BASIC_AUTH – The Secrets Manager ARN of your secret key used for basic authentication with your Confluent schema registry.

      • 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 with your Confluent schema registry.

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

      • OAUTHBEARER_AUTH – The Secrets Manager ARN of your secret key containing the OAuth 2.0 credentials that Lambda uses to acquire an access token for your Confluent schema registry. For the contents of the secret, see Configuring the OAuth secret.

      If the service returns an enum value that is not available in the current SDK version, type will return KafkaSchemaRegistryAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of authentication Lambda uses to access your schema registry.

      • BASIC_AUTH – The Secrets Manager ARN of your secret key used for basic authentication with your Confluent schema registry.

      • 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 with your Confluent schema registry.

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

      • OAUTHBEARER_AUTH – The Secrets Manager ARN of your secret key containing the OAuth 2.0 credentials that Lambda uses to acquire an access token for your Confluent schema registry. For the contents of the secret, see Configuring the OAuth secret.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of authentication Lambda uses to access your schema registry.

      • BASIC_AUTH – The Secrets Manager ARN of your secret key used for basic authentication with your Confluent schema registry.

      • 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 with your Confluent schema registry.

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

      • OAUTHBEARER_AUTH – The Secrets Manager ARN of your secret key containing the OAuth 2.0 credentials that Lambda uses to acquire an access token for your Confluent schema registry. For the contents of the secret, see Configuring the OAuth secret.

      If the service returns an enum value that is not available in the current SDK version, type will return KafkaSchemaRegistryAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of authentication Lambda uses to access your schema registry.

      • BASIC_AUTH – The Secrets Manager ARN of your secret key used for basic authentication with your Confluent schema registry.

      • 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 with your Confluent schema registry.

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

      • OAUTHBEARER_AUTH – The Secrets Manager ARN of your secret key containing the OAuth 2.0 credentials that Lambda uses to acquire an access token for your Confluent schema registry. For the contents of the secret, see Configuring the OAuth secret.

      See Also:

    • uri

      public final String uri()

      The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.

      Returns:
      The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.

    • toBuilder

      public KafkaSchemaRegistryAccessConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<KafkaSchemaRegistryAccessConfig.Builder,KafkaSchemaRegistryAccessConfig>
      Returns:
      a builder for type T

    • builder

      public static KafkaSchemaRegistryAccessConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KafkaSchemaRegistryAccessConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.