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 { Plugin } from '@alicloud/ros-cdk-apigateway'
new Plugin(scope: Construct, id: string, props: PluginProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	PluginProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: PluginProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { Plugin } from '@alicloud/ros-cdk-apigateway'
Plugin.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

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

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrDescription^Required

public readonly attrDescription: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrPluginData^Required

public readonly attrPluginData: IResolvable;

• Type: @alicloud/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 readonly attrPluginId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PluginId: The generated plugin ID.

---

attrPluginName^Required

public readonly attrPluginName: IResolvable;

• Type: @alicloud/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 readonly attrPluginType: IResolvable;

• Type: @alicloud/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.

---