Skip to content

AppUserProps

Properties for defining a AppUser.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-sag-appuser

Initializer

import { AppUserProps } from '@alicloud/ros-cdk-sag'
const appUserProps: AppUserProps = { ... }

Properties

Name Type Description
bandwidth number | @alicloud/ros-cdk-core.IResolvable Property bandwidth: The maximum bandwidth value.
smartAgId string | @alicloud/ros-cdk-core.IResolvable Property smartAgId: The ID of the SAG APP instance.
userMail string | @alicloud/ros-cdk-core.IResolvable Property userMail: The email address of the user.
clientIp string | @alicloud/ros-cdk-core.IResolvable Property clientIp: After this feature is enabled, you must specify the IP address of SAG APP.
disable boolean | @alicloud/ros-cdk-core.IResolvable Property disable: Disable user or not.
password string | @alicloud/ros-cdk-core.IResolvable Property password: The password that is used to log on to the SAG app.
userName string | @alicloud/ros-cdk-core.IResolvable Property userName: The username of the client account.

bandwidthRequired

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

Property bandwidth: The maximum bandwidth value.

Unit: Kbit\/s. Valid values: 1 to 20000. Default value: 2000.


smartAgIdRequired

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

Property smartAgId: The ID of the SAG APP instance.


userMailRequired

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

Property userMail: The email address of the user.

The username and password are sent to the specified email address.


clientIpOptional

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

Property clientIp: After this feature is enabled, you must specify the IP address of SAG APP.

In this case, SAG APP connects to Alibaba Cloud through the specified IP address. Note The IP address must fall into the CIDR block of the private network. After this feature is disabled, an IP address within the CIDR block of the private network is assigned to SAG APP. Each connection to Alibaba Cloud uses a different IP address.


disableOptional

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

Property disable: Disable user or not.


passwordOptional

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

Property password: The password that is used to log on to the SAG app.

The password must be 8 to 32 characters in length. It can contain letters, digits, underscores (_), at signs (@), and hyphens (-). It must start with a letter or a digit.


userNameOptional

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

Property userName: The username of the client account.

The usernames of client accounts added to the same SAG app instance must be unique. The username must be 7 to 33 characters in length, and can contain letters, digits, underscores (_), at signs (@), periods (.), and hyphens (-). It must start with a letter or a digit.

For a client account, if you specify the username, you must also specify the password. If you specify the password, you must specify the username.