Skip to content

IPlugin

  • Extends: @alicloud/ros-cdk-core.IResource

  • Implemented By: Plugin, IPlugin

Represents a Plugin.

Properties

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

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node for this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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.


stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


attrDescriptionRequired

public readonly attrDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrPluginDataRequired

public readonly attrPluginData: string | IResolvable;
  • Type: string | @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.


attrPluginIdRequired

public readonly attrPluginId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PluginId: The generated plugin ID.


attrPluginNameRequired

public readonly attrPluginName: string | IResolvable;
  • Type: string | @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 ().


attrPluginTypeRequired

public readonly attrPluginType: string | IResolvable;
  • Type: string | @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.


propsRequired

public readonly props: PluginProps;