Skip to content

IPlugin

  • Extends: ros_cdk_core.IResource

  • Implemented By: Plugin, IPlugin

Represents a Plugin.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: The description of the plug-in, which cannot exceed 200 characters.
attr_plugin_data typing.Union[str, ros_cdk_core.IResolvable] Attribute PluginData: The definition statement of the plug-in.
attr_plugin_id typing.Union[str, ros_cdk_core.IResolvable] Attribute PluginId: The generated plugin ID.
attr_plugin_name typing.Union[str, ros_cdk_core.IResolvable] Attribute PluginName: The name of the plug-in that you want to create.
attr_plugin_type typing.Union[str, ros_cdk_core.IResolvable] Attribute PluginType: The type of the plug-in.
props PluginProps No description.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.

envRequired 

env: IResourceEnvironment
  • Type: 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 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

attr_descriptionRequired 

attr_description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_plugin_dataRequired 

attr_plugin_data: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

attr_plugin_idRequired 

attr_plugin_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute PluginId: The generated plugin ID.

attr_plugin_nameRequired 

attr_plugin_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 ().

attr_plugin_typeRequired 

attr_plugin_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

props: PluginProps