User
- Implements: IUser
This class encapsulates and extends the ROS resource type ALIYUN::EdsUser::User, which is used to create a convenience user.
Initializers
import com.aliyun.ros.cdk.edsuser.User;
User.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.endUserId(java.lang.String)
.endUserId(IResolvable)
// .autoLockTime(java.lang.String)
// .autoLockTime(IResolvable)
// .businessChannel(java.lang.String)
// .businessChannel(IResolvable)
// .email(java.lang.String)
// .email(IResolvable)
// .isLocalAdmin(java.lang.Boolean)
// .isLocalAdmin(IResolvable)
// .orgId(java.lang.String)
// .orgId(IResolvable)
// .ownerType(java.lang.String)
// .ownerType(IResolvable)
// .password(java.lang.String)
// .password(IResolvable)
// .passwordExpireDays(java.lang.String)
// .passwordExpireDays(IResolvable)
// .phone(java.lang.String)
// .phone(IResolvable)
// .realNickName(java.lang.String)
// .realNickName(IResolvable)
// .remark(java.lang.String)
// .remark(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. |
endUserId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property endUserId: The name of the end user. |
autoLockTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property autoLockTime: The date when the account is automatically locked. |
businessChannel | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property businessChannel: The business channel. |
email | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property email: The email address of the end user. |
isLocalAdmin | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property isLocalAdmin: Whether to set this convenient account as a local administrator. |
orgId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property orgId: The organization to which the end user belongs. |
ownerType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ownerType: The type of the account ownership. |
password | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property password: The initial password. |
passwordExpireDays | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property passwordExpireDays: The default password is valid indefinitely. |
phone | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property phone: Mobile numbers are not supported on the international site. |
realNickName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property realNickName: The display name of the user. |
remark | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property remark: The remarks of the end user. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
endUserIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property endUserId: The name of the end user.
The name must be 3 to 24 characters in length, and can contain lowercase letters, digits, and underscores (_).
autoLockTimeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property autoLockTime: The date when the account is automatically locked.
Format: yyyy-MM-dd HH:mm:ss.
businessChannelOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property businessChannel: The business channel.
emailOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property email: The email address of the end user.
The email address is used to receive notifications about events such as desktop assignment. You must specify an email address or a mobile number to receive notifications.
isLocalAdminOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property isLocalAdmin: Whether to set this convenient account as a local administrator.
orgIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property orgId: The organization to which the end user belongs.
ownerTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ownerType: The type of the account ownership.
Enumeration Value: CreateFromManager Normal
passwordOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property password: The initial password.
If this parameter is left empty, an email for password reset is sent to the specified email address.
passwordExpireDaysOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property passwordExpireDays: The default password is valid indefinitely.
This parameter can be used to set a validity period of 30 to 365 days. When the password expires, the end user must change the password before logging in again.
This feature is currently in invitation-only testing. To try it, submit a ticket to enable it.
phoneOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property phone: Mobile numbers are not supported on the international site.
realNickNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property realNickName: The display name of the user.
remarkOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property remark: The remarks of the end user.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.edsuser.User;
User.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrEndUserId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EndUserId: The name of the end user. |
props | UserProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrEndUserIdRequired
public java.lang.Object getAttrEndUserId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EndUserId: The name of the end user.
propsRequired
public UserProps getProps();
- Type: UserProps