DATASOURCE::APIG::PluginClass - Resource Orchestration Service

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

Syntax

{
  "Type": "DATASOURCE::APIG::PluginClass",
  "Properties": {
    "PluginClassId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

PluginClassId

String

Yes

The ID of the plug-in class.

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

Type: the plug-in class.
Description: the description of the plug-in class.
PluginClassName: the name of the plug-in class.
Alias: the alias of the plug-in class.
WasmLanguage: the WebAssembly (Wasm) language type.
Document: the plug-in document.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PluginClassId:
    Type: String
    Description:
      en: The ID of the plugin class.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::PluginClass
    Properties:
      PluginClassId:
        Ref: PluginClassId
Outputs:
  Type:
    Description: The type of the plugin class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Type
  Description:
    Description: The description of the plugin class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  PluginClassName:
    Description: The name of the plugin class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PluginClassName
  Alias:
    Description: The alias of the plugin class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Alias
  WasmLanguage:
    Description: Wasm language.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - WasmLanguage
  Document:
    Description: The document of the plugin.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Document

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PluginClassId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the plugin class."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::PluginClass",
      "Properties": {
        "PluginClassId": {
          "Ref": "PluginClassId"
        }
      }
    }
  },
  "Outputs": {
    "Type": {
      "Description": "The type of the plugin class.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Type"
        ]
      }
    },
    "Description": {
      "Description": "The description of the plugin class.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "PluginClassName": {
      "Description": "The name of the plugin class.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PluginClassName"
        ]
      }
    },
    "Alias": {
      "Description": "The alias of the plugin class.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Alias"
        ]
      }
    },
    "WasmLanguage": {
      "Description": "Wasm language.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "WasmLanguage"
        ]
      }
    },
    "Document": {
      "Description": "The document of the plugin.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Document"
        ]
      }
    }
  }
}