PluginConfig
- Implements: IPluginConfig
This class encapsulates and extends the ROS resource type ALIYUN::MSE::PluginConfig.
Initializers
import com.aliyun.ros.cdk.mse.PluginConfig;
PluginConfig.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.configLevel(java.lang.Number)
.configLevel(IResolvable)
.enable(java.lang.Boolean)
.enable(IResolvable)
.gatewayUniqueId(java.lang.String)
.gatewayUniqueId(IResolvable)
.pluginId(java.lang.Number)
.pluginId(IResolvable)
// .config(java.lang.String)
// .config(IResolvable)
// .resourceIdList(IResolvable)
// .resourceIdList(java.util.List<java.lang.Number)
// .resourceIdList(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. |
configLevel | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property configLevel: The scope of the plugin application. |
enable | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enable: Whether to enable the plugin. |
gatewayUniqueId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property gatewayUniqueId: The unique ID of the gateway. |
pluginId | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property pluginId: The ID of the gateway plugin. |
config | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property config: The configuration of the plugin. |
resourceIdList | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property resourceIdList: List of domain IDs\/route IDs (depending on ConfigLevel). |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
configLevelRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property configLevel: The scope of the plugin application.
- 0: Global
- 1: Route
- 2: Domain
enableRequired
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enable: Whether to enable the plugin.
gatewayUniqueIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property gatewayUniqueId: The unique ID of the gateway.
pluginIdRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property pluginId: The ID of the gateway plugin.
configOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property config: The configuration of the plugin.
For Wasm plugins, the content is in YAML format. For Lua plugins, the content is Lua code.
resourceIdListOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property resourceIdList: List of domain IDs\/route IDs (depending on ConfigLevel).
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.mse.PluginConfig;
PluginConfig.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrPluginConfigId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PluginConfigId: The ID of the plugin config. |
props | PluginConfigProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrPluginConfigIdRequired
public java.lang.Object getAttrPluginConfigId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PluginConfigId: The ID of the plugin config.
propsRequired
public PluginConfigProps getProps();
- Type: PluginConfigProps