Application

• Implements: IApplication

This class encapsulates and extends the ROS resource type ALIYUN::RAM::Application.

Initializers

import com.aliyun.ros.cdk.ram.Application;
Application.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .appName(java.lang.String)
    .appName(IResolvable)
    .appType(java.lang.String)
    .appType(IResolvable)
    .displayName(java.lang.String)
    .displayName(IResolvable)
//  .accessTokenValidity(java.lang.Number)
//  .accessTokenValidity(IResolvable)
//  .isMultiTenant(java.lang.Boolean)
//  .isMultiTenant(IResolvable)
//  .predefinedScopes(IResolvable)
//  .predefinedScopes(java.util.List<java.lang.String)
//  .predefinedScopes(IResolvable>)
//  .redirectUris(IResolvable)
//  .redirectUris(java.util.List<java.lang.String)
//  .redirectUris(IResolvable>)
//  .refreshTokenValidity(java.lang.Number)
//  .refreshTokenValidity(IResolvable)
//  .requiredScopes(IResolvable)
//  .requiredScopes(java.util.List<java.lang.String)
//  .requiredScopes(IResolvable>)
//  .secretRequired(java.lang.Boolean)
//  .secretRequired(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

appName^Required

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

Property appName: The name of the application.

The name can be up to 64 characters in length. The name can contain letters, digits, periods (.), underscores (_), and hyphens (-).

appType^Required

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

Property appType: The type of the application.

Valid values:

• WebApp: a web application that interacts with a browser.
• NativeApp: a native application that runs on an operating system, such as a desktop operating system or a mobile operating system.
• ServerApp: an application that accesses Alibaba Cloud services without the need of manual user logon. User provisioning is automated based on the System for Cross-Domain Identity Management (SCIM) protocol.

displayName^Required

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

Property displayName: The display name of the application.

The name can be up to 24 characters in length.

accessTokenValidity^Optional

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

Property accessTokenValidity: The validity period of the access token.

Valid values: 900 to 10800. Unit: seconds. Default value: 3600.

isMultiTenant^Optional

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

Property isMultiTenant: Indicates whether the application can be installed by using other Alibaba Cloud accounts.

Valid values:

• true: If you do not set this parameter for applications of the NativeApp and ServerApp types, true is used.
• false: If you do not set this parameter for applications of the WebApp type, false is used.

predefinedScopes^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property predefinedScopes: List of the scopes of application permissions.

redirectUris^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property redirectUris: List of the callback URLs.

refreshTokenValidity^Optional

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

Property refreshTokenValidity: The validity period of the refresh token.

Valid values: 7200 to 31536000. Unit: seconds. Default value:

• If not specified, the default value is 2,592,000 seconds (30 days) for NativeApp and ServerApp applications.
• If not specified, the default value is 7,776,000 seconds (90 days) for WebApp applications.

requiredScopes^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property requiredScopes: Required scope of application permissions.

You can set one or more of the scopes set in the PredefinedScopes to be required, so that when a user authorizes the application, the required scopes are selected by default and cannot be canceled. Notes: If you set a RequiredScopes entry that is not within the scope of PredefinedScopes, the required range will not take effect.

secretRequired^Optional

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

Property secretRequired: Indicates whether a secret is required.

Valid values: true and false. Note:

• For applications of the WebApp and ServerApp types, this parameter is automatically set to true and cannot be changed.
• For applications of the NativeApp type, this parameter can be set to true or false. If you do not set this parameter, false is used. Applications of the NativeApp type run in untrusted environments and the secrets of these applications are not protected. Therefore, we recommend that you do not set this parameter to true unless otherwise specified.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ram.Application;
Application.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrAppId^Required

public java.lang.Object getAttrAppId();

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

Attribute AppId: The ID of the application.

attrAppName^Required

public java.lang.Object getAttrAppName();

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

Attribute AppName: The name of the application.

props^Required

public ApplicationProps getProps();

• Type: ApplicationProps