DATASOURCE::ApiGateway::Apps is used to query applications.

Syntax

{
  "Type": "DATASOURCE::ApiGateway::Apps",
  "Properties": {
    "AppOwner": String,
    "AppId": String
  }
}

Properties

Property Type Required Editable Description Constraint
AppOwner String No Yes The Alibaba Cloud account ID of the application owner. None
AppId String No Yes The ID of the application. None

Return values (Fn::GetAtt)

  • AppIds: the IDs of the applications.
  • Apps: the details of the applications.
Parameter Type Description Constraint
AppIds List The IDs of the applications. None.
Apps List The details of the applications. None.
AppName String The name of the application. None.
AppId String The ID of the application. None.
Description String The description of the application. None.

Examples

  • JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AppId": {
      "Type": "String",
      "Description": "Unique ID of the app."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Apps",
      "Properties": {
        "AppId": {
          "Ref": "AppId"
        }
      }
    }
  },
  "Outputs": {
    "Apps": {
      "Description": "The information about ApiGateway apps.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Apps"
        ]
      }
    },
    "AppIds": {
      "Description": "The list of The ApiGateway app ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AppIds"
        ]
      }
    }
  }
}

  • YAML format 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AppId:
    Type: String
    Description: Unique ID of the app.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Apps
    Properties:
      AppId:
        Ref: AppId
Outputs:
  Apps:
    Description: The information about ApiGateway apps.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Apps
  AppIds:
    Description: The list of The ApiGateway app ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AppIds