Skip to content

User

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

Initializers

import ros_cdk_edsuser
ros_cdk_edsuser.User(
  scope: Construct,
  id: str,
  end_user_id: typing.Union[str, IResolvable],
  auto_lock_time: typing.Union[str, IResolvable] = None,
  business_channel: typing.Union[str, IResolvable] = None,
  email: typing.Union[str, IResolvable] = None,
  is_local_admin: typing.Union[bool, IResolvable] = None,
  org_id: typing.Union[str, IResolvable] = None,
  owner_type: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  password_expire_days: typing.Union[str, IResolvable] = None,
  phone: typing.Union[str, IResolvable] = None,
  real_nick_name: typing.Union[str, IResolvable] = None,
  remark: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
end_user_id typing.Union[str, ros_cdk_core.IResolvable] Property endUserId: The name of the end user.
auto_lock_time typing.Union[str, ros_cdk_core.IResolvable] Property autoLockTime: The date when the account is automatically locked.
business_channel typing.Union[str, ros_cdk_core.IResolvable] Property businessChannel: The channel.
email typing.Union[str, ros_cdk_core.IResolvable] Property email: The email address of the end user.
is_local_admin typing.Union[bool, ros_cdk_core.IResolvable] Property isLocalAdmin: Whether to set this convenient account as a local administrator.
org_id typing.Union[str, ros_cdk_core.IResolvable] Property orgId: The organization to which the end user belongs.
owner_type typing.Union[str, ros_cdk_core.IResolvable] Property ownerType: The type of the account ownership.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: The initial password.
password_expire_days typing.Union[str, ros_cdk_core.IResolvable] Property passwordExpireDays: The default password is valid indefinitely.
phone typing.Union[str, ros_cdk_core.IResolvable] Property phone: Mobile numbers are not supported on the international site.
real_nick_name typing.Union[str, ros_cdk_core.IResolvable] Property realNickName: The display name of the user.
remark typing.Union[str, ros_cdk_core.IResolvable] Property remark: The remarks of the end user.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

end_user_idRequired

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


auto_lock_timeOptional

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

Property autoLockTime: The date when the account is automatically locked.

Format: yyyy-MM-dd HH:mm:ss.


business_channelOptional

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

Property businessChannel: The channel.


emailOptional

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


is_local_adminOptional

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

Property isLocalAdmin: Whether to set this convenient account as a local administrator.


org_idOptional

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

Property orgId: The organization to which the end user belongs.


owner_typeOptional

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

Property ownerType: The type of the account ownership.

Enumeration Value: CreateFromManager Normal


passwordOptional

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


password_expire_daysOptional

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

Property phone: Mobile numbers are not supported on the international site.


real_nick_nameOptional

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

Property realNickName: The display name of the user.


remarkOptional

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

Property remark: The remarks of the end user.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • 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

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_end_user_id typing.Union[str, ros_cdk_core.IResolvable] Attribute EndUserId: The name of the end user.
props UserProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_end_user_idRequired

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

Attribute EndUserId: The name of the end user.


propsRequired

props: UserProps

Structs