SaslUser

This class encapsulates and extends the ROS resource type ALIYUN::KAFKA::SaslUser, which is used to create a Simple Authentication and Security Layer (SASL) user.

Initializers

import ros_cdk_kafka
ros_cdk_kafka.SaslUser(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No 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.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

instance_id^Required

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

Property instanceId: The instance ID.

---

password^Required

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

Property password: The password of the SASL user.

---

username^Required

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

Property username: The name of the SASL user.

---

mechanism^Optional

• 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.

---

type^Optional

• 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.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_kafka
ros_cdk_kafka.SaslUser.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_instance_id	ros_cdk_core.IResolvable	Attribute InstanceId: The instance ID.
attr_username	ros_cdk_core.IResolvable	Attribute Username: The user name of the instance.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_instance_id^Required

attr_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceId: The instance ID.

---

attr_username^Required

attr_username: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Username: The user name of the instance.

---