DATASOURCE::APIG::Plugins - Resource Orchestration Service

DATASOURCE::APIG::Plugins is used to query plug-ins.

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
GatewayId	String	No	Yes	The ID of the Cloud-native API Gateway instance.	None.
PluginClassId	String	No	Yes	The ID of the plug-in class.	None.
PluginClassName	String	No	Yes	The name of the plug-in.	None.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

PluginIds: the IDs of the plug-ins.
Plugins: details of the plug-ins.

Property	Type	Description	Constraint
PluginIds	List	The IDs of the plugins.	None.
Plugins	List	Details of the plug-ins.	None.
GatewayId	String	The ID of the Cloud-native API Gateway instance.	None.
PluginId	String	The ID of the plug-in.	None.
GatewayName	String	The name of the Cloud-native API Gateway instance.	None.
PluginClassId	String	The ID of the plug-in class.	None.
PluginClassName	String	The name of the plug-in class.	None.

Examples

YAML

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

JSON

{
  "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"
        ]
      }
    }
  }
}