Skip to content

App

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::App, which is used to create an application.

Before you call a third-party API, you must create an application and use the application as an identity to call the API.

Initializers 

import com.aliyun.ros.cdk.apigateway.App;
App.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .appName(java.lang.String)
    .appName(IResolvable)
//  .appCode(java.lang.String)
//  .appCode(IResolvable)
//  .appKey(java.lang.String)
//  .appKey(IResolvable)
//  .appSecret(java.lang.String)
//  .appSecret(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .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 App.Need [4, 26] Chinese\English\Number characters or "_",and should start with Chinese\/English character.
appCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property appCode: The app code of the APP.
appKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property appKey: The key of the APP.
appSecret java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property appSecret: The secret of the APP.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description of the App, less than 180 characters.
tags java.util.List<TagsProperty> Property tags: Tags to attach to app.

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 App.Need [4, 26] Chinese\English\Number characters or "_",and should start with Chinese\/English character.

appCodeOptional

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

Property appCode: The app code of the APP.

The length is 8~128 English characters, which can contain numbers, underscores (_) and dashes (-),and AppCode is globally unique.

appKeyOptional

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

Property appKey: The key of the APP.

The length is 8~128 English characters, which can contain numbers, underscores (_) and dashes (-), and AppKey is globally unique.

appSecretOptional

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

Property appSecret: The secret of the APP.

The length is 8~128 English characters, which can contain numbers, underscores (_) and dashes (-).

descriptionOptional

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

Property description: Description of the App, less than 180 characters.

tagsOptional

Property tags: Tags to attach to app.

Max support 20 tags to add during create app. Each tag with two properties Key and Value, and Key is required.

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.apigateway.App;
App.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.
attrAppCode com.aliyun.ros.cdk.core.IResolvable Attribute AppCode: The code of the APP.
attrAppId com.aliyun.ros.cdk.core.IResolvable Attribute AppId: The id of the created APP.
attrAppKey com.aliyun.ros.cdk.core.IResolvable Attribute AppKey: The key of the APP.
attrAppSecret com.aliyun.ros.cdk.core.IResolvable Attribute AppSecret: The secret of the APP.
attrTags com.aliyun.ros.cdk.core.IResolvable Attribute Tags: Tags of app.

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

attrAppCodeRequired 

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

Attribute AppCode: The code of the APP.

attrAppIdRequired 

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

Attribute AppId: The id of the created APP.

attrAppKeyRequired 

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

Attribute AppKey: The key of the APP.

attrAppSecretRequired 

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

Attribute AppSecret: The secret of the APP.

attrTagsRequired 

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

Attribute Tags: Tags of app.