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 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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
directory_id typing.Union[str, ros_cdk_core.IResolvable] Property directoryId: The ID of the directory.
user_name typing.Union[str, ros_cdk_core.IResolvable] Property userName: The name of the user.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the user.
display_name typing.Union[str, ros_cdk_core.IResolvable] Property displayName: The display name of the user.
email typing.Union[str, ros_cdk_core.IResolvable] Property email: The email address of the user.
first_name typing.Union[str, ros_cdk_core.IResolvable] Property firstName: The first name of the user.
last_name typing.Union[str, ros_cdk_core.IResolvable] Property lastName: The last name of the user.
status typing.Union[str, ros_cdk_core.IResolvable] Property status: The status of the user.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

directory_idRequired

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

Property directoryId: The ID of the directory.

user_nameRequired

  • 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.

descriptionOptional

  • 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_nameOptional

  • 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.

emailOptional

  • 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_nameOptional

  • 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_nameOptional

  • 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.

statusOptional

  • 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_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.
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

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_cloudsso
ros_cdk_cloudsso.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.
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_user_id ros_cdk_core.IResolvable Attribute UserId: The ID of the user.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

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_user_idRequired 

attr_user_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UserId: The ID of the user.