Skip to content

UserProps

Properties for defining a User.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ram-user

Initializer

import { UserProps } from '@alicloud/ros-cdk-ram'
const userProps: UserProps = { ... }

Properties

Name Type Description
userName string | @alicloud/ros-cdk-core.IResolvable Property userName: Specifies the user name, containing up to 64 characters.
comments string | @alicloud/ros-cdk-core.IResolvable Property comments: Comments of ram user.
deletionForce boolean | @alicloud/ros-cdk-core.IResolvable Property deletionForce: Whether force detach the policies and groups attached to the user.
displayName string | @alicloud/ros-cdk-core.IResolvable Property displayName: Display name, up to 128 characters or Chinese characters.
email string | @alicloud/ros-cdk-core.IResolvable Property email: Email of ram user.
groups any[] | @alicloud/ros-cdk-core.IResolvable Property groups: A name of a group to which you want to add the user.
loginProfile @alicloud/ros-cdk-core.IResolvable | LoginProfileProperty Property loginProfile: Creates a login profile for users so that they can access the AliCloud Management Console.
mobilePhone string | @alicloud/ros-cdk-core.IResolvable Property mobilePhone: Phone number of ram user.
policies @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PoliciesProperty[] Property policies: Describes what actions are allowed on what resources.
policyAttachments @alicloud/ros-cdk-core.IResolvable | PolicyAttachmentsProperty Property policyAttachments: System and custom policy names to attach.

userNameRequired

public readonly userName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property userName: Specifies the user name, containing up to 64 characters.


commentsOptional

public readonly comments: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property comments: Comments of ram user.


deletionForceOptional

public readonly deletionForce: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deletionForce: Whether force detach the policies and groups attached to the user.

Default value is false.


displayNameOptional

public readonly displayName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property displayName: Display name, up to 128 characters or Chinese characters.


emailOptional

public readonly email: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property email: Email of ram user.


groupsOptional

public readonly groups: any[] | IResolvable;
  • Type: any[] | @alicloud/ros-cdk-core.IResolvable

Property groups: A name of a group to which you want to add the user.


loginProfileOptional

public readonly loginProfile: IResolvable | LoginProfileProperty;

Property loginProfile: Creates a login profile for users so that they can access the AliCloud Management Console.


mobilePhoneOptional

public readonly mobilePhone: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property mobilePhone: Phone number of ram user.


policiesOptional

public readonly policies: IResolvable | IResolvable | PoliciesProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PoliciesProperty[]

Property policies: Describes what actions are allowed on what resources.


policyAttachmentsOptional

public readonly policyAttachments: IResolvable | PolicyAttachmentsProperty;

Property policyAttachments: System and custom policy names to attach.