PluginAttachment

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

Initializers

import { PluginAttachment } from '@alicloud/ros-cdk-apig'
new PluginAttachment(scope: Construct, id: string, props: PluginAttachmentProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	PluginAttachmentProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: PluginAttachmentProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { PluginAttachment } from '@alicloud/ros-cdk-apig'
PluginAttachment.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrAttachResourceId	@alicloud/ros-cdk-core.IResolvable	Attribute AttachResourceId: The resource ID to be attached by the plugin.
attrAttachResourceIds	@alicloud/ros-cdk-core.IResolvable	Attribute AttachResourceIds: The list of resource IDs to be attached by the plugin.
attrAttachResourceNames	@alicloud/ros-cdk-core.IResolvable	Attribute AttachResourceNames: The list of resource names to be attached by the plugin.
attrAttachResourceParentIds	@alicloud/ros-cdk-core.IResolvable	Attribute AttachResourceParentIds: The list of parent IDs for resources to be attached by the plugin.
attrAttachResourceType	@alicloud/ros-cdk-core.IResolvable	Attribute AttachResourceType: The type of the resource to be attached by the plugin.
attrEnable	@alicloud/ros-cdk-core.IResolvable	Attribute Enable: Whether to enable this plugin.
attrEnvironmentId	@alicloud/ros-cdk-core.IResolvable	Attribute EnvironmentId: The ID of the environment.
attrPluginAttachmentId	@alicloud/ros-cdk-core.IResolvable	Attribute PluginAttachmentId: The ID of plugin attachment.
attrPluginClassInfo	@alicloud/ros-cdk-core.IResolvable	Attribute PluginClassInfo: The type of the plugin.
attrPluginInfo	@alicloud/ros-cdk-core.IResolvable	Attribute PluginInfo: The information about the association of plugin with gateway instance.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrAttachResourceId^Required

public readonly attrAttachResourceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrAttachResourceIds^Required

public readonly attrAttachResourceIds: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrAttachResourceNames^Required

public readonly attrAttachResourceNames: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrAttachResourceParentIds^Required

public readonly attrAttachResourceParentIds: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrAttachResourceType^Required

public readonly attrAttachResourceType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrEnable^Required

public readonly attrEnable: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Enable: Whether to enable this plugin.

---

attrEnvironmentId^Required

public readonly attrEnvironmentId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentId: The ID of the environment.

---

attrPluginAttachmentId^Required

public readonly attrPluginAttachmentId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PluginAttachmentId: The ID of plugin attachment.

---

attrPluginClassInfo^Required

public readonly attrPluginClassInfo: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PluginClassInfo: The type of the plugin.

---

attrPluginInfo^Required

public readonly attrPluginInfo: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---