Skip to content

User

This class encapsulates and extends the ROS resource type ALIYUN::CloudSSO::User, which is used to create a user.

Initializers 

import com.aliyun.ros.cdk.cloudsso.User;
User.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .directoryId(java.lang.String)
    .directoryId(IResolvable)
    .userName(java.lang.String)
    .userName(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .displayName(java.lang.String)
//  .displayName(IResolvable)
//  .email(java.lang.String)
//  .email(IResolvable)
//  .firstName(java.lang.String)
//  .firstName(IResolvable)
//  .lastName(java.lang.String)
//  .lastName(IResolvable)
//  .status(java.lang.String)
//  .status(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.
directoryId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property directoryId: The ID of the directory.
userName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property userName: The name of the user.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the user.
displayName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property displayName: The display name of the user.
email java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property email: The email address of the user.
firstName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property firstName: The first name of the user.
lastName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property lastName: The last name of the user.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: The status of the user.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

directoryIdRequired

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

Property directoryId: The ID of the directory.

userNameRequired

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

Property userName: The name of the user.

The name must be unique within the directory. The name cannot be changed. The name can contain numbers, letters, and the following special characters: @_-. The name can be up to 64 characters in length.

descriptionOptional

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

Property description: The description of the user.

The description can be up to 1,024 characters in length.

displayNameOptional

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

Property displayName: The display name of the user.

The name can be up to 256 characters in length.

emailOptional

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

Property email: The email address of the user.

The email address must be unique within the directory. The email address can be up to 128 characters in length.

firstNameOptional

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

Property firstName: The first name of the user.

The name can be up to 64 characters in length.

lastNameOptional

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

Property lastName: The last name of the user.

The name can be up to 64 characters in length.

statusOptional

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

Property status: The status of the user.

Valid values:

  • Enabled: The logon of the user is enabled. This is the default value.
  • Disabled: The logon of the user is disabled.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • 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.
attrUserId com.aliyun.ros.cdk.core.IResolvable Attribute UserId: The ID of the user.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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

attrUserIdRequired 

public IResolvable getAttrUserId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UserId: The ID of the user.