Skip to content

Application

This class encapsulates and extends the ROS resource type ALIYUN::RAM::Application, which is used to create an 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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
appName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property appName: The name of the application.
appType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property appType: The type of the application.
displayName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property displayName: The display name of the application.
accessTokenValidity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property accessTokenValidity: The validity period of the access token.
isMultiTenant 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.
predefinedScopes com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property predefinedScopes: List of the scopes of application permissions.
redirectUris com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property redirectUris: List of the callback URLs.
refreshTokenValidity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property refreshTokenValidity: The validity period of the refreshed token.
requiredScopes com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property requiredScopes: Required scope of application permissions.
secretRequired java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property secretRequired: Indicates whether a secret is required.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

appNameRequired

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

appTypeRequired

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

displayNameRequired

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

accessTokenValidityOptional

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

isMultiTenantOptional

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

predefinedScopesOptional

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

Property predefinedScopes: List of the scopes of application permissions.

redirectUrisOptional

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

Property redirectUris: List of the callback URLs.

refreshTokenValidityOptional

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

Property refreshTokenValidity: The validity period of the refreshed token.

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

  • For applications of the WebApp and ServerApp types, if this parameter is left empty, the value 2592000 is used. The value 2592000 indicates that the validity period of the refreshed token is 30 days.
  • For applications of the NativeApp type, if this parameter is left empty, the value 7776000 is used. The value 7776000 indicates that the validity period of the refreshed token is 90 days.

requiredScopesOptional

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

secretRequiredOptional

  • 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

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.ram.Application;
Application.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.
attrAppId com.aliyun.ros.cdk.core.IResolvable Attribute AppId: The ID of the application.
attrAppName com.aliyun.ros.cdk.core.IResolvable Attribute AppName: The name of the application.

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

attrAppIdRequired 

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

Attribute AppId: The ID of the application.

attrAppNameRequired 

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

Attribute AppName: The name of the application.