DATASOURCE::APIG::Plugins

更新时间:
复制 MD 格式

DATASOURCE::APIG::Plugins类型用于获取插件列表。

语法

{
  "Type": "DATASOURCE::APIG::Plugins",
  "Properties": {
    "GatewayId": String,
    "PluginClassId": String,
    "PluginClassName": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

GatewayId

String

否

是

网关实例 id 。

无

PluginClassId

String

否

是

插件类型 id。

无

PluginClassName

String

否

是

插件类型名称。

无

RefreshOptions

String

否

是

当资源栈更新时,数据源资源的刷新策略。

有效值:

  • Never(默认值):更新堆栈时,从不刷新数据源资源。

  • Always:更新堆栈时,始终刷新数据源资源。

返回值

Fn::GetAtt

  • PluginIds:插件 ID 列表。

  • Plugins:插件详情列表。

属性名称

类型

描述

约束

PluginIds

List

插件 ID 列表。

无

Plugins

List

插件详情列表。

无

GatewayId

String

网关 id。

无

PluginId

String

插件 ID。

无

GatewayName

String

网关名称。

无

PluginClassId

String

插件类型 ID。

无

PluginClassName

String

插件类型名称。

无

示例

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PluginClassId:
    Type: String
    Description:
      en: The ID of the plugin class.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::Plugins
    Properties:
      PluginClassId:
        Ref: PluginClassId
Outputs:
  PluginIds:
    Description: The list of plugin IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PluginIds
  Plugins:
    Description: The list of plugins.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Plugins
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PluginClassId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the plugin class."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::Plugins",
      "Properties": {
        "PluginClassId": {
          "Ref": "PluginClassId"
        }
      }
    }
  },
  "Outputs": {
    "PluginIds": {
      "Description": "The list of plugin IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PluginIds"
        ]
      }
    },
    "Plugins": {
      "Description": "The list of plugins.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Plugins"
        ]
      }
    }
  }
}