ALIYUN::MSE::PluginConfig - Resource Orchestration Service

The ALIYUN::MSE::PluginConfig resource creates a plugin configuration.

Syntax

{
  "Type": "ALIYUN::MSE::PluginConfig",
  "Properties": {
    "ConfigLevel": Integer,
    "Enable": Boolean,
    "GatewayUniqueId": String,
    "PluginId": Integer,
    "Config": String,
    "ResourceIdList": List
  }
}

Properties

Property name	Type	Required	Update allowed	Description	Constraints
ConfigLevel	Integer	Yes	No	The application scope of the plugin.	Valid values: Global: 0 Routing: 1 2: Domain name
Enable	Boolean	Yes	Yes	Specifies whether to enable the plugin.	None
GatewayUniqueId	String	Yes	No	The unique ID of the gateway.	None
PluginId	Integer	Yes	No	The ID of the gateway plugin.	None
Config	String	No	Yes	The plugin configuration.	The configuration of a WebAssembly (Wasm) plugin is in YAML format. The configuration of a Lua plugin is Lua code.
ResourceIdList	List	No	Yes	A list of domain name IDs or route IDs.	Supports a maximum of 100 IDs.

Return value

Fn::GetAtt

PluginConfigId: The ID of the plugin configuration.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ConfigLevel:
    Type: Number
    Description:
      en: |-
        The scope of the plugin application.
        - 0: Global
        - 1: Route
        - 2: Domain
    AllowedValues:
      - 0
      - 1
      - 2
    Required: true
  GatewayUniqueId:
    Type: String
    Description:
      en: The unique ID of the gateway.
    Required: true
  Enable:
    Type: Boolean
    Description:
      en: Whether to enable the plugin.
    Required: true
  PluginId:
    Type: Number
    Description:
      en: The ID of the gateway plugin.
    Required: true
Resources:
  PluginConfig:
    Type: ALIYUN::MSE::PluginConfig
    Properties:
      ConfigLevel:
        Ref: ConfigLevel
      GatewayUniqueId:
        Ref: GatewayUniqueId
      Enable:
        Ref: Enable
      PluginId:
        Ref: PluginId
Outputs:
  PluginConfigId:
    Description: The ID of the plugin configuration.
    Value:
      Fn::GetAtt:
        - PluginConfig
        - PluginConfigId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ConfigLevel": {
      "Type": "Number",
      "Description": {
        "en": "The scope of the plugin application.\n- 0: Global\n- 1: Route\n- 2: Domain"
      },
      "AllowedValues": [
        0,
        1,
        2
      ],
      "Required": true
    },
    "GatewayUniqueId": {
      "Type": "String",
      "Description": {
        "en": "The unique ID of the gateway."
      },
      "Required": true
    },
    "Enable": {
      "Type": "Boolean",
      "Description": {
        "en": "Whether to enable the plugin."
      },
      "Required": true
    },
    "PluginId": {
      "Type": "Number",
      "Description": {
        "en": "The ID of the gateway plugin."
      },
      "Required": true
    }
  },
  "Resources": {
    "PluginConfig": {
      "Type": "ALIYUN::MSE::PluginConfig",
      "Properties": {
        "ConfigLevel": {
          "Ref": "ConfigLevel"
        },
        "GatewayUniqueId": {
          "Ref": "GatewayUniqueId"
        },
        "Enable": {
          "Ref": "Enable"
        },
        "PluginId": {
          "Ref": "PluginId"
        }
      }
    }
  },
  "Outputs": {
    "PluginConfigId": {
      "Description": "The ID of the plugin configuration.",
      "Value": {
        "Fn::GetAtt": [
          "PluginConfig",
          "PluginConfigId"
        ]
      }
    }
  }
}