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 com.aliyun.ros.cdk.kafka.SaslUser;
SaslUser.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .password(java.lang.String)
    .password(IResolvable)
    .username(java.lang.String)
    .username(IResolvable)
//  .mechanism(java.lang.String)
//  .mechanism(IResolvable)
//  .type(java.lang.String)
//  .type(IResolvable)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
instanceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceId: The instance ID.
password	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property password: The password of the SASL user.
username	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property username: The name of the SASL user.
mechanism	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property mechanism: The encryption method.
type	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property type: The type of the Simple Authentication and Security Layer (SASL) user.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

instanceId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceId: The instance ID.

---

password^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property password: The password of the SASL user.

---

username^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property username: The name of the SASL user.

---

mechanism^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

import com.aliyun.ros.cdk.kafka.SaslUser;
SaslUser.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceId: The instance ID.
attrUsername	com.aliyun.ros.cdk.core.IResolvable	Attribute Username: The user name of the instance.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrInstanceId^Required

public IResolvable getAttrInstanceId();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The instance ID.

---

attrUsername^Required

public IResolvable getAttrUsername();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Username: The user name of the instance.

---