SaslSslSettings

pydantic model safir.kafka.SaslSslSettings

Subset of settings required for SASL PLAINTEXT auth.

Parameters:

data (Any)

Show JSON schema

{
   "title": "SaslSslSettings",
   "description": "Subset of settings required for SASL PLAINTEXT auth.",
   "type": "object",
   "properties": {
      "bootstrap_servers": {
         "title": "Bootstrap Servers",
         "type": "string"
      },
      "security_protocol": {
         "enum": [
            "SASL_PLAINTEXT",
            "SASL_SSL"
         ],
         "title": "Security Protocol",
         "type": "string"
      },
      "sasl_mechanism": {
         "$ref": "#/$defs/SaslMechanism",
         "default": "SCRAM-SHA-512"
      },
      "sasl_username": {
         "title": "Sasl Username",
         "type": "string"
      },
      "sasl_password": {
         "format": "password",
         "title": "Sasl Password",
         "type": "string",
         "writeOnly": true
      },
      "cluster_ca_path": {
         "anyOf": [
            {
               "format": "file-path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Cluster Ca Path"
      }
   },
   "$defs": {
      "SaslMechanism": {
         "description": "Kafka SASL mechanisms.",
         "enum": [
            "PLAIN",
            "SCRAM-SHA-256",
            "SCRAM-SHA-512"
         ],
         "title": "SaslMechanism",
         "type": "string"
      }
   },
   "required": [
      "bootstrap_servers",
      "security_protocol",
      "sasl_username",
      "sasl_password",
      "cluster_ca_path"
   ]
}

Fields:

• bootstrap_servers (str)

• cluster_ca_path (pathlib.Path | None)

• sasl_mechanism (safir.kafka._kafka_config.SaslMechanism)

• sasl_password (pydantic.types.SecretStr)

• sasl_username (str)

• security_protocol (Literal[safir.kafka._kafka_config.SecurityProtocol.SASL_PLAINTEXT, safir.kafka._kafka_config.SecurityProtocol.SASL_SSL])

field bootstrap_servers: str [Required]

field cluster_ca_path: FilePath | None [Required]

field sasl_mechanism: SaslMechanism = SaslMechanism.SCRAM_SHA_512

field sasl_password: SecretStr [Required]

field sasl_username: str [Required]

field security_protocol: Literal[SecurityProtocol.SASL_PLAINTEXT, SecurityProtocol.SASL_SSL] [Required]

to_aiokafka_params()

Return type:

AIOKafkaParams

to_faststream_params()

Return type:

FastStreamBrokerParams

to_ssl_context()

Make an SSL context for connecting to Kafka.

Return type:

SSLContext