Plugin

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::Plugin, which is used to create an API Gateway plug-in.

Initializers

import com.aliyun.ros.cdk.apigateway.Plugin;
Plugin.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No 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.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

pluginData^Required

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

---

pluginName^Required

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

---

pluginType^Required

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

---

description^Optional

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

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

---

tags^Optional

• Type: java.util.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.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

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

---

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

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.apigateway.Plugin;
Plugin.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute Description: The description of the plug-in, which cannot exceed 200 characters.
attrPluginData	com.aliyun.ros.cdk.core.IResolvable	Attribute PluginData: The definition statement of the plug-in.
attrPluginId	com.aliyun.ros.cdk.core.IResolvable	Attribute PluginId: The generated plugin ID.
attrPluginName	com.aliyun.ros.cdk.core.IResolvable	Attribute PluginName: The name of the plug-in that you want to create.
attrPluginType	com.aliyun.ros.cdk.core.IResolvable	Attribute PluginType: The type of the plug-in.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

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

---

attrDescription^Required

public IResolvable getAttrDescription();

• Type: com.aliyun.ros.cdk.core.IResolvable

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

---

attrPluginData^Required

public IResolvable getAttrPluginData();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PluginData: The definition statement of the plug-in.

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

---

attrPluginId^Required

public IResolvable getAttrPluginId();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PluginId: The generated plugin ID.

---

attrPluginName^Required

public IResolvable getAttrPluginName();

• Type: com.aliyun.ros.cdk.core.IResolvable

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

---

attrPluginType^Required

public IResolvable getAttrPluginType();

• Type: com.aliyun.ros.cdk.core.IResolvable

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

---