All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::ApiGateway::Apps

Last Updated:Nov 01, 2024

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

Syntax

{
  "Type": "DATASOURCE::ApiGateway::Apps",
  "Properties": {
    "AppOwner": String,
    "AppId": String,
    "RefreshOptions": 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 unique ID of the application.

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)

  • AppIds: the IDs of the applications.

  • Apps: details of the applications.

Property

Type

Description

Constraint

AppIds

List

The IDs of the applications.

None.

Apps

List

Details of the applications.

None.

AppName

String

The application name.

None.

AppId

String

The application ID.

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