Skip to content

PluginProps

Properties for defining a Plugin.

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

Initializer 

import ros_cdk_apigateway
ros_cdk_apigateway.PluginProps(
  plugin_data: typing.Union[str, IResolvable],
  plugin_name: typing.Union[str, IResolvable],
  plugin_type: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None
)

Properties

Name Type Description
plugin_data typing.Union[str, ros_cdk_core.IResolvable] Property pluginData: The definition statement of the plug-in.
plugin_name typing.Union[str, ros_cdk_core.IResolvable] Property pluginName: The name of the plug-in that you want to create.
plugin_type typing.Union[str, ros_cdk_core.IResolvable] Property pluginType: The type of the plug-in.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the plug-in, which cannot exceed 200 characters.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.

plugin_dataRequired 

plugin_data: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

plugin_nameRequired 

plugin_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 ().

plugin_typeRequired 

plugin_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

tagsOptional 

tags: typing.List[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.