Plugin

• Implements: IPlugin

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::Plugin.

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();

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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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 java.lang.Object getAttrDescription();

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

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

attrPluginData^Required

public java.lang.Object getAttrPluginData();

• Type: java.lang.String OR 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 java.lang.Object getAttrPluginId();

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

Attribute PluginId: The generated plugin ID.

attrPluginName^Required

public java.lang.Object getAttrPluginName();

• Type: java.lang.String OR 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 java.lang.Object getAttrPluginType();

• Type: java.lang.String OR 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.

props^Required

public PluginProps getProps();

• Type: PluginProps