PluginAttachment

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

Initializers

import ros_cdk_apig
ros_cdk_apig.PluginAttachment(
  scope: Construct,
  id: str,
  plugin_info: typing.Union[IResolvable, PluginInfoProperty],
  attach_resource_id: typing.Union[str, IResolvable] = None,
  attach_resource_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  attach_resource_type: typing.Union[str, IResolvable] = None,
  enable: typing.Union[bool, IResolvable] = None,
  environment_id: 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.
`plugin_info`	`typing.Union[ros_cdk_core.IResolvable, PluginInfoProperty]`	Property pluginInfo: The information about the association of plugin with gateway instance.
`attach_resource_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property attachResourceId: The resource ID to be attached by the plugin.
`attach_resource_ids`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property attachResourceIds: The list of resource IDs to be attached by the plugin.
`attach_resource_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property attachResourceType: The type of the resource to be attached by the plugin.
`enable`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property enable: Whether to enable this plugin, default value is false.
`environment_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property environmentId: The ID of the environment.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`plugin_info`^Required

Type: typing.Union[ros_cdk_core.IResolvable, PluginInfoProperty]

Property pluginInfo: The information about the association of plugin with gateway instance.

`attach_resource_id`^Optional

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

Property attachResourceId: The resource ID to be attached by the plugin.

`attach_resource_ids`^Optional

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

Property attachResourceIds: The list of resource IDs to be attached by the plugin.

`attach_resource_type`^Optional

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

Property attachResourceType: The type of the resource to be attached by the plugin.

`enable`^Optional

Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enable: Whether to enable this plugin, default value is false.

`environment_id`^Optional

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

Property environmentId: The ID of the environment.

`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.PluginAttachment.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_attach_resource_id`	`ros_cdk_core.IResolvable`	Attribute AttachResourceId: The resource ID to be attached by the plugin.
`attr_attach_resource_ids`	`ros_cdk_core.IResolvable`	Attribute AttachResourceIds: The list of resource IDs to be attached by the plugin.
`attr_attach_resource_names`	`ros_cdk_core.IResolvable`	Attribute AttachResourceNames: The list of resource names to be attached by the plugin.
`attr_attach_resource_parent_ids`	`ros_cdk_core.IResolvable`	Attribute AttachResourceParentIds: The list of parent IDs for resources to be attached by the plugin.
`attr_attach_resource_type`	`ros_cdk_core.IResolvable`	Attribute AttachResourceType: The type of the resource to be attached by the plugin.
`attr_enable`	`ros_cdk_core.IResolvable`	Attribute Enable: Whether to enable this plugin.
`attr_environment_id`	`ros_cdk_core.IResolvable`	Attribute EnvironmentId: The ID of the environment.
`attr_plugin_attachment_id`	`ros_cdk_core.IResolvable`	Attribute PluginAttachmentId: The ID of plugin attachment.
`attr_plugin_class_info`	`ros_cdk_core.IResolvable`	Attribute PluginClassInfo: The type of the plugin.
`attr_plugin_info`	`ros_cdk_core.IResolvable`	Attribute PluginInfo: The information about the association of plugin with gateway instance.

`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_attach_resource_id`^Required

attr_attach_resource_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AttachResourceId: The resource ID to be attached by the plugin.

`attr_attach_resource_ids`^Required

attr_attach_resource_ids: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AttachResourceIds: The list of resource IDs to be attached by the plugin.

`attr_attach_resource_names`^Required

attr_attach_resource_names: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AttachResourceNames: The list of resource names to be attached by the plugin.

`attr_attach_resource_parent_ids`^Required

attr_attach_resource_parent_ids: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AttachResourceParentIds: The list of parent IDs for resources to be attached by the plugin.

`attr_attach_resource_type`^Required

attr_attach_resource_type: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AttachResourceType: The type of the resource to be attached by the plugin.

`attr_enable`^Required

attr_enable: IResolvable

Type: ros_cdk_core.IResolvable

Attribute Enable: Whether to enable this plugin.

`attr_environment_id`^Required

attr_environment_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute EnvironmentId: The ID of the environment.

`attr_plugin_attachment_id`^Required

attr_plugin_attachment_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute PluginAttachmentId: The ID of plugin attachment.

`attr_plugin_class_info`^Required

attr_plugin_class_info: IResolvable

Type: ros_cdk_core.IResolvable

Attribute PluginClassInfo: The type of the plugin.

`attr_plugin_info`^Required

attr_plugin_info: IResolvable

Type: ros_cdk_core.IResolvable

Attribute PluginInfo: The information about the association of plugin with gateway instance.

PluginAttachment

Initializers

scopeRequired

idRequired

plugin_infoRequired

attach_resource_idOptional

attach_resource_idsOptional

attach_resource_typeOptional

enableOptional

environment_idOptional

enable_resource_property_constraintOptional

Methods

to_string

synthesize

add_condition

add_count

add_dependency

add_resource_desc

apply_removal_policy

get_att

set_metadata