Plugin

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Apigateway;
new Plugin(Construct Scope, string Id, PluginProps Props, bool EnableResourcePropertyConstraint = null);

Name	Type	Description
Scope	AlibabaCloud.SDK.ROS.CDK.Core.Construct	No description.
Id	string	No description.
Props	PluginProps	No description.
EnableResourcePropertyConstraint	bool	No description.

---

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

---

Id^Required

• Type: string

---

Props^Required

• Type: PluginProps

---

EnableResourcePropertyConstraint^Optional

• Type: bool

---

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

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

---

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

---

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

---

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

---

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

---

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

---

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

---

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

---

Value^Required

• Type: object

---

Static Functions

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

---

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Apigateway;
Plugin.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

---

Properties

Name	Type	Description
Node	AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode	The construct tree node associated with this construct.
Ref	string	No description.
Stack	AlibabaCloud.SDK.ROS.CDK.Core.Stack	The stack in which this resource is defined.
Resource	AlibabaCloud.SDK.ROS.CDK.Core.RosResource	No description.
AttrDescription	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute Description: The description of the plug-in, which cannot exceed 200 characters.
AttrPluginData	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute PluginData: The definition statement of the plug-in.
AttrPluginId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute PluginId: The generated plugin ID.
AttrPluginName	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute PluginName: The name of the plug-in that you want to create.
AttrPluginType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	Attribute PluginType: The type of the plug-in.

---

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

---

Ref^Required

public string Ref { get; }

• Type: string

---

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

---

Resource^Optional

public RosResource Resource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

---

AttrDescription^Required

public IResolvable AttrDescription { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

---

AttrPluginData^Required

public IResolvable AttrPluginData { get; }

• Type: AlibabaCloud.SDK.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 AttrPluginId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PluginId: The generated plugin ID.

---

AttrPluginName^Required

public IResolvable AttrPluginName { get; }

• Type: AlibabaCloud.SDK.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 AttrPluginType { get; }

• Type: AlibabaCloud.SDK.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.

---