Skip to content

PluginProps

Properties for defining a Plugin.

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

Initializer 

import com.aliyun.ros.cdk.apigateway.PluginProps;
PluginProps.builder()
    .pluginData(java.lang.String)
    .pluginData(IResolvable)
    .pluginName(java.lang.String)
    .pluginName(IResolvable)
    .pluginType(java.lang.String)
    .pluginType(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

Properties

Name Type Description
pluginData java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property pluginData: The definition statement of the plug-in.
pluginName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property pluginName: The name of the plug-in that you want to create.
pluginType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property pluginType: The type of the plug-in.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the plug-in, which cannot exceed 200 characters.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.

pluginDataRequired 

public java.lang.Object getPluginData();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getPluginName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getPluginType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

tagsOptional 

public java.util.List<TagsProperty> getTags();

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.