Skip to content

SaslUserProps

Properties for defining a SaslUser.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-sasluser

Initializer

import ros_cdk_kafka
ros_cdk_kafka.SaslUserProps(
  instance_id: typing.Union[str, IResolvable],
  password: typing.Union[str, IResolvable],
  username: typing.Union[str, IResolvable],
  mechanism: typing.Union[str, IResolvable] = None,
  type: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The instance ID.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: The password of the SASL user.
username typing.Union[str, ros_cdk_core.IResolvable] Property username: The name of the SASL user.
mechanism typing.Union[str, ros_cdk_core.IResolvable] Property mechanism: The encryption method.
type typing.Union[str, ros_cdk_core.IResolvable] Property type: The type of the Simple Authentication and Security Layer (SASL) user.

instance_idRequired

instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The instance ID.


passwordRequired

password: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property password: The password of the SASL user.


usernameRequired

username: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property username: The name of the SASL user.


mechanismOptional

mechanism: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property mechanism: The encryption method.

Valid values: SCRAM-SHA-512 (default) SCRAM-SHA-256 Note This parameter is available only for ApsaraMQ for Kafka V3 serverless instances.


typeOptional

type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property type: The type of the Simple Authentication and Security Layer (SASL) user.

Valid values: plain: a simple mechanism that uses usernames and passwords to verify user identities. ApsaraMQ for Kafka provides an improved PLAIN mechanism that allows you to dynamically add SASL users without the need to restart an instance. SCRAM: a mechanism that uses usernames and passwords to verify user identities. Compared with the PLAIN mechanism, this mechanism provides better security protection. ApsaraMQ for Kafka uses the SCRAM-SHA-256 algorithm. LDAP: This value is available only for the SASL users of ApsaraMQ for Confluent instances. Default value: plain.