Skip to content

PluginProps

Properties for defining a Plugin.

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

Initializer 

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

Properties

Name Type Description
pluginData string | @alicloud/ros-cdk-core.IResolvable Property pluginData: The definition statement of the plug-in.
pluginName string | @alicloud/ros-cdk-core.IResolvable Property pluginName: The name of the plug-in that you want to create.
pluginType string | @alicloud/ros-cdk-core.IResolvable Property pluginType: The type of the plug-in.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the plug-in, which cannot exceed 200 characters.
tags TagsProperty[] Property tags: Tags to attach to instance.

pluginDataRequired 

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

Property pluginData: The definition statement of the plug-in.

Plug-in definition statements in the JSON and YAML formats are supported.

pluginNameRequired 

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

Property pluginName: The name of the plug-in that you want to create.

It can contain uppercase English letters, lowercase English letters, Chinese characters, numbers, and underscores (). It must be 4 to 50 characters in length and cannot start with an underscore ().

pluginTypeRequired 

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

Property pluginType: The type of the plug-in.

Valid values: ipControl: indicates IP address-based access control. trafficControl: indicates throttling. backendSignature: indicates backend signature. jwtAuth: indicates JWT (OpenId Connect). cors: indicates cross-origin resource access (CORS). caching: indicates caching.

descriptionOptional 

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

Property description: The description of the plug-in, which cannot exceed 200 characters.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to instance.

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