Skip to content

AppUser

This class encapsulates and extends the ROS resource type ALIYUN::SAG::AppUser, which is used to create a client account for a Smart Access Gateway (SAG) app instance.

Initializers 

import ros_cdk_sag
ros_cdk_sag.AppUser(
  scope: Construct,
  id: str,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable],
  smart_ag_id: typing.Union[str, IResolvable],
  user_mail: typing.Union[str, IResolvable],
  client_ip: typing.Union[str, IResolvable] = None,
  disable: typing.Union[bool, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  user_name: 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.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property bandwidth: The bandwidth.
smart_ag_id typing.Union[str, ros_cdk_core.IResolvable] Property smartAgId: The ID of the SAG APP instance.
user_mail typing.Union[str, ros_cdk_core.IResolvable] Property userMail: The email address of the user.
client_ip typing.Union[str, ros_cdk_core.IResolvable] Property clientIp: After this feature is enabled, you must specify the IP address of SAG APP.
disable typing.Union[bool, ros_cdk_core.IResolvable] Property disable: Disable user or not.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: The password used to log on to SAG APP.
user_name typing.Union[str, ros_cdk_core.IResolvable] Property userName: The username of the client account.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

bandwidthRequired

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

Property bandwidth: The bandwidth.

Unit: Kbit/s. Maximum bandwidth: 2,000 Kbit/s.

smart_ag_idRequired

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

Property smartAgId: The ID of the SAG APP instance.

user_mailRequired

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

Property userMail: The email address of the user.

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

client_ipOptional

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

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

Property disable: Disable user or not.

passwordOptional

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

Property password: The password used to log on to SAG APP.

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

user_nameOptional

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

Property userName: The username of the client account.

Usernames of client accounts added to the same SAG APP instance must be unique. For a client account, if you specify the username, you must also specify the password.

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_sag
ros_cdk_sag.AppUser.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_smart_ag_id ros_cdk_core.IResolvable Attribute SmartAGId: The ID of the SAG APP instance.
attr_user_name ros_cdk_core.IResolvable Attribute UserName: .

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_smart_ag_idRequired 

attr_smart_ag_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SmartAGId: The ID of the SAG APP instance.

attr_user_nameRequired 

attr_user_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UserName: .