User

• Implements: IUser

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

Initializers

import ros_cdk_cloudsso
ros_cdk_cloudsso.User(
  scope: Construct,
  id: str,
  directory_id: typing.Union[str, IResolvable],
  user_name: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  display_name: typing.Union[str, IResolvable] = None,
  email: typing.Union[str, IResolvable] = None,
  first_name: typing.Union[str, IResolvable] = None,
  last_name: typing.Union[str, IResolvable] = None,
  status: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

directory_id^Required

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

Property directoryId: The ID of the directory.

user_name^Required

• Type: typing.Union[str, 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.

description^Optional

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

Property description: The description of the user.

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

display_name^Optional

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

Property displayName: The display name of the user.

The name can be up to 256 characters in length.

email^Optional

• Type: typing.Union[str, 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.

first_name^Optional

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

Property firstName: The first name of the user.

The name can be up to 64 characters in length.

last_name^Optional

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

Property lastName: The last name of the user.

The name can be up to 64 characters in length.

status^Optional

• Type: typing.Union[str, 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

is_construct

import ros_cdk_cloudsso
ros_cdk_cloudsso.User.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

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_user_id^Required

attr_user_id: typing.Union[str, IResolvable]

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

Attribute UserId: The ID of the user.

props^Required

props: UserProps

• Type: UserProps