App

• Implements: IApp

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::App.

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();

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

appCode^Optional

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

appKey^Optional

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

appSecret^Optional

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

description^Optional

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

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

tags^Optional

• Type: java.util.List<TagsProperty>

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

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.apigateway.App;
App.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

attrAppCode^Required

public java.lang.Object getAttrAppCode();

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

Attribute AppCode: The code of the APP.

attrAppId^Required

public java.lang.Object getAttrAppId();

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

Attribute AppId: The id of the created APP.

attrAppKey^Required

public java.lang.Object getAttrAppKey();

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

Attribute AppKey: The key of the APP.

attrAppSecret^Required

public java.lang.Object getAttrAppSecret();

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

Attribute AppSecret: The secret of the APP.

attrTags^Required

public java.lang.Object getAttrTags();

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

Attribute Tags: Tags of app.

props^Required

public AppProps getProps();

• Type: AppProps