PluginAttachment

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

Initializers

import com.aliyun.ros.cdk.apig.PluginAttachment;
PluginAttachment.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .pluginInfo(IResolvable)
    .pluginInfo(PluginInfoProperty)
//  .attachResourceId(java.lang.String)
//  .attachResourceId(IResolvable)
//  .attachResourceIds(IResolvable)
//  .attachResourceIds(java.util.List<java.lang.String)
//  .attachResourceIds(IResolvable>)
//  .attachResourceType(java.lang.String)
//  .attachResourceType(IResolvable)
//  .enable(java.lang.Boolean)
//  .enable(IResolvable)
//  .environmentId(java.lang.String)
//  .environmentId(IResolvable)
    .build();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No description.
`pluginInfo`	`com.aliyun.ros.cdk.core.IResolvable OR PluginInfoProperty`	Property pluginInfo: The information about the association of plugin with gateway instance.
`attachResourceId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property attachResourceId: The resource ID to be attached by the plugin.
`attachResourceIds`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.List`	Property attachResourceIds: The list of resource IDs to be attached by the plugin.
`attachResourceType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property attachResourceType: The type of the resource to be attached by the plugin.
`enable`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property enable: Whether to enable this plugin, default value is false.
`environmentId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property environmentId: The ID of the environment.

`scope`^Required

Type: com.aliyun.ros.cdk.core.Construct

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`pluginInfo`^Required

Type: com.aliyun.ros.cdk.core.IResolvable OR PluginInfoProperty

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

`attachResourceId`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

`attachResourceIds`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

`attachResourceType`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

`enable`^Optional

Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

`environmentId`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property environmentId: The ID of the environment.

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 java.lang.String toString()

Returns a string representation of this construct.

`synthesize`

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

Type: com.aliyun.ros.cdk.core.RosCondition

`addCount`

public void addCount(java.lang.Number OR IResolvable count)

count^Required

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

Type: com.aliyun.ros.cdk.core.RemovalPolicy

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

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

`isConstruct`

import com.aliyun.ros.cdk.apig.PluginAttachment;
PluginAttachment.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

Type: java.lang.Object

Properties

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

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrAttachResourceId`^Required

public IResolvable getAttrAttachResourceId();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrAttachResourceIds`^Required

public IResolvable getAttrAttachResourceIds();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrAttachResourceNames`^Required

public IResolvable getAttrAttachResourceNames();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrAttachResourceParentIds`^Required

public IResolvable getAttrAttachResourceParentIds();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrAttachResourceType`^Required

public IResolvable getAttrAttachResourceType();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrEnable`^Required

public IResolvable getAttrEnable();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Enable: Whether to enable this plugin.

`attrEnvironmentId`^Required

public IResolvable getAttrEnvironmentId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EnvironmentId: The ID of the environment.

`attrPluginAttachmentId`^Required

public IResolvable getAttrPluginAttachmentId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PluginAttachmentId: The ID of plugin attachment.

`attrPluginClassInfo`^Required

public IResolvable getAttrPluginClassInfo();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PluginClassInfo: The type of the plugin.

`attrPluginInfo`^Required

public IResolvable getAttrPluginInfo();

Type: com.aliyun.ros.cdk.core.IResolvable

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

PluginAttachment

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

pluginInfoRequired

attachResourceIdOptional

attachResourceIdsOptional

attachResourceTypeOptional

enableOptional

environmentIdOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata