PluginClass

This class encapsulates and extends the ROS resource type ALIYUN::APIG::PluginClass.

Initializers

import ros_cdk_apig
ros_cdk_apig.PluginClass(
  scope: Construct,
  id: str,
  description: typing.Union[str, IResolvable],
  execute_priority: typing.Union[typing.Union[int, float], IResolvable],
  execute_stage: typing.Union[str, IResolvable],
  plugin_class_name: typing.Union[str, IResolvable],
  version: typing.Union[str, IResolvable],
  version_description: typing.Union[str, IResolvable],
  wasm_language: typing.Union[str, IResolvable],
  wasm_url: typing.Union[str, IResolvable],
  alias: typing.Union[str, IResolvable] = None,
  supported_min_gateway_version: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: The description of the plugin class.
execute_priority	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property executePriority: The execute priority of the Plugin.
execute_stage	typing.Union[str, ros_cdk_core.IResolvable]	Property executeStage: The Execution stage.
plugin_class_name	typing.Union[str, ros_cdk_core.IResolvable]	Property pluginClassName: The name of the plugin class.
version	typing.Union[str, ros_cdk_core.IResolvable]	Property version: The version of plugin class.
version_description	typing.Union[str, ros_cdk_core.IResolvable]	Property versionDescription: The description of the version .
wasm_language	typing.Union[str, ros_cdk_core.IResolvable]	Property wasmLanguage: the language of the wasm.
wasm_url	typing.Union[str, ros_cdk_core.IResolvable]	Property wasmUrl: The url of the wasm.
alias	typing.Union[str, ros_cdk_core.IResolvable]	Property alias: The alias of the plugin class.
supported_min_gateway_version	typing.Union[str, ros_cdk_core.IResolvable]	Property supportedMinGatewayVersion: The supported minimum gateway version.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

description^Required

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

Property description: The description of the plugin class.

---

execute_priority^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property executePriority: The execute priority of the Plugin.

---

execute_stage^Required

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

Property executeStage: The Execution stage.

---

plugin_class_name^Required

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

Property pluginClassName: The name of the plugin class.

---

version^Required

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

Property version: The version of plugin class.

---

version_description^Required

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

Property versionDescription: The description of the version .

---

wasm_language^Required

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

Property wasmLanguage: the language of the wasm.

---

wasm_url^Required

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

Property wasmUrl: The url of the wasm.

---

alias^Optional

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

Property alias: The alias of the plugin class.

---

supported_min_gateway_version^Optional

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

Property supportedMinGatewayVersion: The supported minimum gateway version.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

import ros_cdk_apig
ros_cdk_apig.PluginClass.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_alias	ros_cdk_core.IResolvable	Attribute Alias: The alias of the plugin class.
attr_description	ros_cdk_core.IResolvable	Attribute Description: The description of the plugin class.
attr_document	ros_cdk_core.IResolvable	Attribute Document: The document of plugin.
attr_plugin_class_name	ros_cdk_core.IResolvable	Attribute PluginClassName: The name of the plugin class.
attr_type	ros_cdk_core.IResolvable	Attribute Type: The type of the plugin class.
attr_wasm_language	ros_cdk_core.IResolvable	Attribute WasmLanguage: Wasm language.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_alias^Required

attr_alias: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Alias: The alias of the plugin class.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: The description of the plugin class.

---

attr_document^Required

attr_document: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Document: The document of plugin.

---

attr_plugin_class_name^Required

attr_plugin_class_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PluginClassName: The name of the plugin class.

---

attr_type^Required

attr_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Type: The type of the plugin class.

---

attr_wasm_language^Required

attr_wasm_language: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute WasmLanguage: Wasm language.

---