Reference documentation and code samples for the Managed Service for Apache Kafka V1 API class Google::Cloud::ManagedKafka::V1::TlsConfig.
The TLS configuration for the Kafka cluster.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#ssl_principal_mapping_rules
defssl_principal_mapping_rules()->::String
Returns
(::String) — Optional. A list of rules for mapping from SSL principal names to
short names. These are applied in order by Kafka.
Refer to the Apache Kafka documentation for ssl.principal.mapping.rules
for the precise formatting details and syntax.
Example: "RULE:^CN=(.?),OU=ServiceUsers.$/$1@example.com/,DEFAULT"
This is a static Kafka broker configuration. Setting or modifying this
field will trigger a rolling restart of the Kafka brokers to apply
the change. An empty string means no rules are applied (Kafka default).
#ssl_principal_mapping_rules=
defssl_principal_mapping_rules=(value)->::String
Parameter
value (::String) — Optional. A list of rules for mapping from SSL principal names to
short names. These are applied in order by Kafka.
Refer to the Apache Kafka documentation for ssl.principal.mapping.rules
for the precise formatting details and syntax.
Example: "RULE:^CN=(.?),OU=ServiceUsers.$/$1@example.com/,DEFAULT"
This is a static Kafka broker configuration. Setting or modifying this
field will trigger a rolling restart of the Kafka brokers to apply
the change. An empty string means no rules are applied (Kafka default).
Returns
(::String) — Optional. A list of rules for mapping from SSL principal names to
short names. These are applied in order by Kafka.
Refer to the Apache Kafka documentation for ssl.principal.mapping.rules
for the precise formatting details and syntax.
Example: "RULE:^CN=(.?),OU=ServiceUsers.$/$1@example.com/,DEFAULT"
This is a static Kafka broker configuration. Setting or modifying this
field will trigger a rolling restart of the Kafka brokers to apply
the change. An empty string means no rules are applied (Kafka default).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Managed Service for Apache Kafka V1 API - Class Google::Cloud::ManagedKafka::V1::TlsConfig (v1.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.0 (latest)](/ruby/docs/reference/google-cloud-managed_kafka-v1/latest/Google-Cloud-ManagedKafka-V1-TlsConfig)\n- [1.3.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/1.3.0/Google-Cloud-ManagedKafka-V1-TlsConfig)\n- [1.2.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/1.2.0/Google-Cloud-ManagedKafka-V1-TlsConfig)\n- [1.1.2](/ruby/docs/reference/google-cloud-managed_kafka-v1/1.1.2/Google-Cloud-ManagedKafka-V1-TlsConfig)\n- [1.0.1](/ruby/docs/reference/google-cloud-managed_kafka-v1/1.0.1/Google-Cloud-ManagedKafka-V1-TlsConfig)\n- [0.5.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.5.0/Google-Cloud-ManagedKafka-V1-TlsConfig)\n- [0.4.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.4.0/Google-Cloud-ManagedKafka-V1-TlsConfig)\n- [0.3.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.3.0/Google-Cloud-ManagedKafka-V1-TlsConfig)\n- [0.2.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.2.0/Google-Cloud-ManagedKafka-V1-TlsConfig)\n- [0.1.3](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.1.3/Google-Cloud-ManagedKafka-V1-TlsConfig) \nReference documentation and code samples for the Managed Service for Apache Kafka V1 API class Google::Cloud::ManagedKafka::V1::TlsConfig.\n\nThe TLS configuration for the Kafka cluster. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #ssl_principal_mapping_rules\n\n def ssl_principal_mapping_rules() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. A list of rules for mapping from SSL principal names to short names. These are applied in order by Kafka. Refer to the Apache Kafka documentation for `ssl.principal.mapping.rules` for the precise formatting details and syntax. Example: \"RULE:\\^CN=(.*?),OU=ServiceUsers.* $/$1@example.com/,DEFAULT\"\n\n\n This is a static Kafka broker configuration. Setting or modifying this\n field will trigger a rolling restart of the Kafka brokers to apply\n the change. An empty string means no rules are applied (Kafka default).\n\n### #ssl_principal_mapping_rules=\n\n def ssl_principal_mapping_rules=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. A list of rules for mapping from SSL principal names to short names. These are applied in order by Kafka. Refer to the Apache Kafka documentation for `ssl.principal.mapping.rules` for the precise formatting details and syntax. Example: \"RULE:\\^CN=(.*?),OU=ServiceUsers.* $/$1@example.com/,DEFAULT\"\n\n\n This is a static Kafka broker configuration. Setting or modifying this\n field will trigger a rolling restart of the Kafka brokers to apply\nthe change. An empty string means no rules are applied (Kafka default). \n**Returns**\n\n- (::String) --- Optional. A list of rules for mapping from SSL principal names to short names. These are applied in order by Kafka. Refer to the Apache Kafka documentation for `ssl.principal.mapping.rules` for the precise formatting details and syntax. Example: \"RULE:\\^CN=(.*?),OU=ServiceUsers.* $/$1@example.com/,DEFAULT\"\n\n\n This is a static Kafka broker configuration. Setting or modifying this\n field will trigger a rolling restart of the Kafka brokers to apply\n the change. An empty string means no rules are applied (Kafka default).\n\n### #trust_config\n\n def trust_config() -\u003e ::Google::Cloud::ManagedKafka::V1::TrustConfig\n\n**Returns**\n\n- ([::Google::Cloud::ManagedKafka::V1::TrustConfig](./Google-Cloud-ManagedKafka-V1-TrustConfig)) --- Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication.\n\n### #trust_config=\n\n def trust_config=(value) -\u003e ::Google::Cloud::ManagedKafka::V1::TrustConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::ManagedKafka::V1::TrustConfig](./Google-Cloud-ManagedKafka-V1-TrustConfig)) --- Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication. \n**Returns**\n\n- ([::Google::Cloud::ManagedKafka::V1::TrustConfig](./Google-Cloud-ManagedKafka-V1-TrustConfig)) --- Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication."]]
