Skip to content

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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

pluginDataRequired

  • 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

  • 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

  • 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

  • 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

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

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

xRequired

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

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrDescriptionRequired 

public IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrPluginDataRequired 

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.

attrPluginIdRequired 

public IResolvable getAttrPluginId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PluginId: The generated plugin ID.

attrPluginNameRequired 

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

attrPluginTypeRequired 

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.