Skip to content

AppUser

This class encapsulates and extends the ROS resource type ALIYUN::SAG::AppUser.

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 maximum bandwidth value.
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 that is used to log on to the 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 maximum bandwidth value.

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


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 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

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


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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SmartAGId: The ID of the SAG APP instance.
attrUserName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UserName: The name of the user.
props AppUserProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


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 java.lang.Object getAttrSmartAgId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SmartAGId: The ID of the SAG APP instance.


attrUserNameRequired

public java.lang.Object getAttrUserName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute UserName: The name of the user.


propsRequired

public AppUserProps getProps();