DATASOURCE::APIG::HttpApis - Resource Orchestration Service

DATASOURCE::APIG::HttpApis is used to query HTTP APIs.

Syntax

{
  "Type": "DATASOURCE::APIG::HttpApis",
  "Properties": {
    "HttpApiName": String,
    "ResourceGroupId": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
HttpApiName	String	No	Yes	The name of the API.	None.
ResourceGroupId	String	No	Yes	The ID of the resource group.	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

HttpApis: details of the APIs.
HttpApiIds: the IDs of the APIs.

Property	Type	Description	Constraint
HttpApiIds	List	The IDs of the APIs.	None.
HttpApis	List	Details of the APIs.	None.
Description	String	The description of the API.	None.
HttpApiId	String	The ID of the API.	None.
BasePath	String	The base path of the API.	None.
ResourceGroupId	String	The ID of the resource group.	None.
HttpApiName	String	The name of the API.	None.
Type	String	The API type.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  HttpApiName:
    Type: String
    Description:
      en: The name of the API.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::HttpApis
    Properties:
      HttpApiName:
        Ref: HttpApiName
Outputs:
  HttpApis:
    Description: The list of http apis.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HttpApis
  HttpApiIds:
    Description: The list of http api IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HttpApiIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HttpApiName": {
      "Type": "String",
      "Description": {
        "en": "The name of the API."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::HttpApis",
      "Properties": {
        "HttpApiName": {
          "Ref": "HttpApiName"
        }
      }
    }
  },
  "Outputs": {
    "HttpApis": {
      "Description": "The list of http apis.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HttpApis"
        ]
      }
    },
    "HttpApiIds": {
      "Description": "The list of http api IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HttpApiIds"
        ]
      }
    }
  }
}