DATASOURCE::APIG::Plugin - Resource Orchestration Service

DATASOURCE::APIG::Plugin is used to query the information about a plug-in.

Syntax

{
  "Type": "DATASOURCE::APIG::Plugin",
  "Properties": {
    "PluginId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

PluginId

String

Yes

The ID of the plug-in.

None.

RefreshOptions

String

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

PluginClassId: the ID of the plug-in class.
GatewayName: the name of the plug-in class.
GatewayId: the ID of the Cloud-native API Gateway instance.
PluginId: the ID of the plug-in.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PluginId:
    Type: String
    Description:
      en: The ID of the plugin.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::Plugin
    Properties:
      PluginId:
        Ref: PluginId
Outputs:
  PluginClassId:
    Description: The ID of the plugin class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PluginClassId
  GatewayName:
    Description: The name of the gateway name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GatewayName
  GatewayId:
    Description: The ID of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GatewayId
  PluginId:
    Description: The ID of the plugin.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PluginId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PluginId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the plugin."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::Plugin",
      "Properties": {
        "PluginId": {
          "Ref": "PluginId"
        }
      }
    }
  },
  "Outputs": {
    "PluginClassId": {
      "Description": "The ID of the plugin class.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PluginClassId"
        ]
      }
    },
    "GatewayName": {
      "Description": "The name of the gateway name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GatewayName"
        ]
      }
    },
    "GatewayId": {
      "Description": "The ID of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GatewayId"
        ]
      }
    },
    "PluginId": {
      "Description": "The ID of the plugin.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PluginId"
        ]
      }
    }
  }
}