SslSettings

pydantic model safir.kafka.SslSettings

Subset of settings required for SSL auth.

Parameters:

data (Any)

Show JSON schema

{
   "title": "SslSettings",
   "description": "Subset of settings required for SSL auth.",
   "type": "object",
   "properties": {
      "bootstrap_servers": {
         "title": "Bootstrap Servers",
         "type": "string"
      },
      "security_protocol": {
         "const": "SSL",
         "enum": [
            "SSL"
         ],
         "title": "Security Protocol",
         "type": "string"
      },
      "cluster_ca_path": {
         "format": "file-path",
         "title": "Cluster Ca Path",
         "type": "string"
      },
      "client_cert_path": {
         "format": "file-path",
         "title": "Client Cert Path",
         "type": "string"
      },
      "client_key_path": {
         "format": "file-path",
         "title": "Client Key Path",
         "type": "string"
      }
   },
   "required": [
      "bootstrap_servers",
      "security_protocol",
      "cluster_ca_path",
      "client_cert_path",
      "client_key_path"
   ]
}

Fields:

• bootstrap_servers (str)

• client_cert_path (pathlib.Path)

• client_key_path (pathlib.Path)

• cluster_ca_path (pathlib.Path)

• security_protocol (Literal[safir.kafka._kafka_config.SecurityProtocol.SSL])

field bootstrap_servers: str [Required]

field client_cert_path: FilePath [Required]

Constraints:

• path_type = file

field client_key_path: FilePath [Required]

Constraints:

• path_type = file

field cluster_ca_path: FilePath [Required]

Constraints:

• path_type = file

field security_protocol: Literal[SecurityProtocol.SSL] [Required]

to_aiokafka_params()

Return type:

AIOKafkaParams

to_faststream_params()

Return type:

FastStreamBrokerParams

to_ssl_context()

Create an SSL context for connecting to Kafka.

Return type:

SSLContext