PluginAttachment

• Implements: IPluginAttachment

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)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: PluginAttachmentProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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

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

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

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.

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: string | IResolvable;

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

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

attrAttachResourceIds^Required

public readonly attrAttachResourceIds: string | IResolvable;

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

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

attrAttachResourceNames^Required

public readonly attrAttachResourceNames: string | IResolvable;

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

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

attrAttachResourceParentIds^Required

public readonly attrAttachResourceParentIds: string | IResolvable;

• Type: string | @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: string | IResolvable;

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

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

attrEnable^Required

public readonly attrEnable: string | IResolvable;

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

Attribute Enable: Whether to enable this plugin.

attrEnvironmentId^Required

public readonly attrEnvironmentId: string | IResolvable;

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

Attribute EnvironmentId: The ID of the environment.

attrPluginAttachmentId^Required

public readonly attrPluginAttachmentId: string | IResolvable;

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

Attribute PluginAttachmentId: The ID of plugin attachment.

attrPluginClassInfo^Required

public readonly attrPluginClassInfo: string | IResolvable;

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

Attribute PluginClassInfo: The type of the plugin.

attrPluginInfo^Required

public readonly attrPluginInfo: string | IResolvable;

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

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

props^Required

public readonly props: PluginAttachmentProps;

• Type: PluginAttachmentProps