User

• Implements: IUser, IPrincipal

This class encapsulates and extends the ROS resource type ALIYUN::RAM::User.

Initializers

import com.aliyun.ros.cdk.ram.User;
User.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .userName(java.lang.String)
    .userName(IResolvable)
//  .comments(java.lang.String)
//  .comments(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .displayName(java.lang.String)
//  .displayName(IResolvable)
//  .email(java.lang.String)
//  .email(IResolvable)
//  .groups(java.util.List<java.lang.Object>)
//  .groups(IResolvable)
//  .loginProfile(IResolvable)
//  .loginProfile(LoginProfileProperty)
//  .mobilePhone(java.lang.String)
//  .mobilePhone(IResolvable)
//  .policies(IResolvable)
//  .policies(java.util.List<IResolvable)
//  .policies(PoliciesProperty>)
//  .policyAttachments(IResolvable)
//  .policyAttachments(PolicyAttachmentsProperty)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

userName^Required

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

Property userName: Specifies the user name, containing up to 64 characters.

comments^Optional

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

Property comments: Comments of ram user.

deletionForce^Optional

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

Property deletionForce: Whether force detach the policies and groups attached to the user.

Default value is false.

displayName^Optional

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

Property displayName: Display name, up to 128 characters or Chinese characters.

email^Optional

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

Property email: Email of ram user.

groups^Optional

• Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

Property groups: A name of a group to which you want to add the user.

loginProfile^Optional

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

Property loginProfile: Creates a login profile for users so that they can access the AliCloud Management Console.

mobilePhone^Optional

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

Property mobilePhone: Phone number of ram user.

policies^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPoliciesProperty>

Property policies: Describes what actions are allowed on what resources.

policyAttachments^Optional

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

Property policyAttachments: System and custom policy names to attach.

Methods

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

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)

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

addToPolicy

public ManagedPolicy addToPolicy(PolicyDocumentProperty policyDocument)

Add to the policy of this principal.

policyDocument^Required

• Type: PolicyDocumentProperty

Static Functions

isConstruct

import com.aliyun.ros.cdk.ram.User;
User.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

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

attrCreateDate^Required

public java.lang.Object getAttrCreateDate();

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

Attribute CreateDate: Create date of ram user.

attrLastLoginDate^Required

public java.lang.Object getAttrLastLoginDate();

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

Attribute LastLoginDate: Last login date of ram user.

attrUserId^Required

public java.lang.Object getAttrUserId();

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

Attribute UserId: Id of ram user.

attrUserName^Required

public java.lang.Object getAttrUserName();

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

Attribute UserName: Name of ram user.

grantPrincipal^Required

public IPrincipal getGrantPrincipal();

• Type: IPrincipal

The principal to grant permissions to.

principalName^Required

public java.lang.Object getPrincipalName();

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

The principal to grant permissions to.

principalType^Required

public java.lang.String getPrincipalType();

• Type: java.lang.String

The principal type, such as 'Group', 'Role', 'User'.

props^Required

public UserProps getProps();

• Type: UserProps