Skip to content

AppProps

Properties for defining a App.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-app

Initializer

import { AppProps } from '@alicloud/ros-cdk-apigateway'
const appProps: AppProps = { ... }

Properties

Name Type Description
appName string | @alicloud/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 string | @alicloud/ros-cdk-core.IResolvable Property appCode: The app code of the APP.
appKey string | @alicloud/ros-cdk-core.IResolvable Property appKey: The key of the APP.
appSecret string | @alicloud/ros-cdk-core.IResolvable Property appSecret: The secret of the APP.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of the App, less than 180 characters.
tags TagsProperty[] Property tags: Tags to attach to app.

appNameRequired

public readonly appName: string | IResolvable;
  • Type: string | @alicloud/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

public readonly appCode: string | IResolvable;
  • Type: string | @alicloud/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

public readonly appKey: string | IResolvable;
  • Type: string | @alicloud/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

public readonly appSecret: string | IResolvable;
  • Type: string | @alicloud/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

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


tagsOptional

public readonly tags: 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.