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 com.aliyun.ros.cdk.sag.AppUser;
AppUser.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .bandwidth(java.lang.Number)
    .bandwidth(IResolvable)
    .smartAgId(java.lang.String)
    .smartAgId(IResolvable)
    .userMail(java.lang.String)
    .userMail(IResolvable)
//  .clientIp(java.lang.String)
//  .clientIp(IResolvable)
//  .disable(java.lang.Boolean)
//  .disable(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .userName(java.lang.String)
//  .userName(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property bandwidth: The bandwidth.
smartAgId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property smartAgId: The ID of the SAG APP instance.
userMail java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property userMail: The email address of the user.
clientIp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clientIp: After this feature is enabled, you must specify the IP address of SAG APP.
disable java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property disable: Disable user or not.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property password: The password used to log on to SAG APP.
userName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property userName: The username of the client account.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bandwidthRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property bandwidth: The bandwidth.

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


smartAgIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property smartAgId: The ID of the SAG APP instance.


userMailRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property userMail: The email address of the user.

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


clientIpOptional

  • Type: java.lang.String OR com.aliyun.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: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property disable: Disable user or not.


passwordOptional

  • Type: java.lang.String OR com.aliyun.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.


userNameOptional

  • Type: java.lang.String OR com.aliyun.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.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.sag.AppUser;
AppUser.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrSmartAgId com.aliyun.ros.cdk.core.IResolvable Attribute SmartAGId: The ID of the SAG APP instance.
attrUserName com.aliyun.ros.cdk.core.IResolvable Attribute UserName: .

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrSmartAgIdRequired

public IResolvable getAttrSmartAgId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SmartAGId: The ID of the SAG APP instance.


attrUserNameRequired

public IResolvable getAttrUserName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UserName: .