User
This class encapsulates and extends the ROS resource type ALIYUN::RAM::User
, which is used to create a Resource Access Management (RAM) user.
Initializers
import ros_cdk_ram
ros_cdk_ram.User(
scope: Construct,
id: str,
user_name: typing.Union[str, IResolvable],
comments: typing.Union[str, IResolvable] = None,
deletion_force: typing.Union[bool, IResolvable] = None,
display_name: typing.Union[str, IResolvable] = None,
email: typing.Union[str, IResolvable] = None,
groups: typing.Union[typing.List[typing.Any], IResolvable] = None,
login_profile: typing.Union[IResolvable, LoginProfileProperty] = None,
mobile_phone: typing.Union[str, IResolvable] = None,
policies: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PoliciesProperty]]] = None,
policy_attachments: typing.Union[IResolvable, PolicyAttachmentsProperty] = None,
enable_resource_property_constraint: bool = None
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
user_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property userName: Specifies the user name, containing up to 64 characters. |
comments |
typing.Union[str, ros_cdk_core.IResolvable] |
Property comments: Comments of ram user. |
deletion_force |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property deletionForce: Whether force detach the policies and groups attached to the user. |
display_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property displayName: Display name, up to 128 characters or Chinese characters. |
email |
typing.Union[str, ros_cdk_core.IResolvable] |
Property email: Email of ram user. |
groups |
typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] |
Property groups: A name of a group to which you want to add the user. |
login_profile |
typing.Union[ros_cdk_core.IResolvable, LoginProfileProperty] |
Property loginProfile: Creates a login profile for users so that they can access the AliCloud Management Console. |
mobile_phone |
typing.Union[str, ros_cdk_core.IResolvable] |
Property mobilePhone: Phone number of ram user. |
policies |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PoliciesProperty]]] |
Property policies: Describes what actions are allowed on what resources. |
policy_attachments |
typing.Union[ros_cdk_core.IResolvable, PolicyAttachmentsProperty] |
Property policyAttachments: System and custom policy names to attach. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
user_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property userName: Specifies the user name, containing up to 64 characters.
comments
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property comments: Comments of ram user.
deletion_force
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property deletionForce: Whether force detach the policies and groups attached to the user.
Default value is false.
display_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property displayName: Display name, up to 128 characters or Chinese characters.
email
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property email: Email of ram user.
groups
Optional
- Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]
Property groups: A name of a group to which you want to add the user.
login_profile
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, LoginProfileProperty]
Property loginProfile: Creates a login profile for users so that they can access the AliCloud Management Console.
mobile_phone
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property mobilePhone: Phone number of ram user.
policies
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PoliciesProperty]]]
Property policies: Describes what actions are allowed on what resources.
policy_attachments
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, PolicyAttachmentsProperty]
Property policyAttachments: System and custom policy names to attach.
enable_resource_property_constraint
Optional
- 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_ram
ros_cdk_ram.User.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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_create_date |
ros_cdk_core.IResolvable |
Attribute CreateDate: Create date of ram user. |
attr_last_login_date |
ros_cdk_core.IResolvable |
Attribute LastLoginDate: Last login date of ram user. |
attr_user_id |
ros_cdk_core.IResolvable |
Attribute UserId: Id of ram user. |
attr_user_name |
ros_cdk_core.IResolvable |
Attribute UserName: Name of ram user. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
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_create_date
Required
attr_create_date: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute CreateDate: Create date of ram user.
attr_last_login_date
Required
attr_last_login_date: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute LastLoginDate: Last login date of ram user.
attr_user_id
Required
attr_user_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute UserId: Id of ram user.
attr_user_name
Required
attr_user_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute UserName: Name of ram user.