Skip to content

SaslUserProps

Properties for defining a SaslUser.

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

Initializer 

import { SaslUserProps } from '@alicloud/ros-cdk-kafka'
const saslUserProps: SaslUserProps = { ... }

Properties

Name Type Description
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: The instance ID.
password string | @alicloud/ros-cdk-core.IResolvable Property password: The password of the SASL user.
username string | @alicloud/ros-cdk-core.IResolvable Property username: The name of the SASL user.
mechanism string | @alicloud/ros-cdk-core.IResolvable Property mechanism: The encryption method.
type string | @alicloud/ros-cdk-core.IResolvable Property type: The type of the Simple Authentication and Security Layer (SASL) user.

instanceIdRequired 

public readonly instanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceId: The instance ID.

passwordRequired 

public readonly password: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property password: The password of the SASL user.

usernameRequired 

public readonly username: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property username: The name of the SASL user.

mechanismOptional 

public readonly mechanism: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly type: string | IResolvable;
  • Type: string | @alicloud/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.