DATASOURCE::APIG::PluginClasses - Resource Orchestration Service

DATASOURCE::APIG::PluginClasses is used to query plug-in classes.

Syntax

{
  "Type": "DATASOURCE::APIG::PluginClasses",
  "Properties": {
    "RefreshOptions": String,
    "Type": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

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.

Type

String

Yes

The plug-in class.

None.

Return values

Fn::GetAtt

PluginClasses: details of the plug-in classes.
PluginClassIds: the IDs of the plug-in classes.

Property	Type	Description	Constraint
PluginClassIds	List	The IDs of the plug-in classes.	None.
PluginClasses	List	Details of the plug-in classes.	None.
Description	String	The description of the plug-in class.	None.
PluginClassId	String	The ID of the plug-in class.	None.
Alias	String	The alias of the plug-in class.	None.
Version	String	The version of the plug-in class.	None.
Type	String	The plug-in class.	None.
PluginClassName	String	The name of the plug-in class.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Type:
    Type: String
    Description:
      en: The type of the plugin class.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::PluginClasses
    Properties:
      Type:
        Ref: Type
Outputs:
  PluginClasses:
    Description: The list of plugin classes.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PluginClasses
  PluginClassIds:
    Description: The list of plugin class IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PluginClassIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Type": {
      "Type": "String",
      "Description": {
        "en": "The type of the plugin class."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::PluginClasses",
      "Properties": {
        "Type": {
          "Ref": "Type"
        }
      }
    }
  },
  "Outputs": {
    "PluginClasses": {
      "Description": "The list of plugin classes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PluginClasses"
        ]
      }
    },
    "PluginClassIds": {
      "Description": "The list of plugin class IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PluginClassIds"
        ]
      }
    }
  }
}