DATASOURCE::APIG::Route - Resource Orchestration Service

DATASOURCE::APIG::Route is used to query the information about a route.

Syntax

{
  "Type": "DATASOURCE::APIG::Route",
  "Properties": {
    "HttpApiId": String,
    "RouteId": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
HttpApiId	String	Yes	Yes	The ID of the HTTP API.	None.
RouteId	String	Yes	Yes	The ID of the route.	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

Backend: the backend service.
Description: the description of the route.
EnvironmentInfo: the environment information.
RouteName: the name of the route.
DomainInfos: the domain name information.
RouteId: the ID of the route.
Match: the matching rule for the route resource.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RouteId:
    Type: String
    Description:
      en: The ID of route resource.
    Required: true
  HttpApiId:
    Type: String
    Description:
      en: The ID of the HTTP API.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::Route
    Properties:
      RouteId:
        Ref: RouteId
      HttpApiId:
        Ref: HttpApiId
Outputs:
  Backend:
    Description: backend services.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Backend
  Description:
    Description: description of route resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  EnvironmentInfo:
    Description: environment information.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnvironmentInfo
  RouteName:
    Description: The name of the route.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RouteName
  DomainInfos:
    Description: domain items.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainInfos
  RouteId:
    Description: The ID of route resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RouteId
  Match:
    Description: the match rule of route resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Match

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RouteId": {
      "Type": "String",
      "Description": {
        "en": "The ID of route resource."
      },
      "Required": true
    },
    "HttpApiId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the HTTP API."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::Route",
      "Properties": {
        "RouteId": {
          "Ref": "RouteId"
        },
        "HttpApiId": {
          "Ref": "HttpApiId"
        }
      }
    }
  },
  "Outputs": {
    "Backend": {
      "Description": "backend services.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Backend"
        ]
      }
    },
    "Description": {
      "Description": "description of route resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "EnvironmentInfo": {
      "Description": "environment information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnvironmentInfo"
        ]
      }
    },
    "RouteName": {
      "Description": "The name of the route.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteName"
        ]
      }
    },
    "DomainInfos": {
      "Description": "domain items.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainInfos"
        ]
      }
    },
    "RouteId": {
      "Description": "The ID of route resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteId"
        ]
      }
    },
    "Match": {
      "Description": "the match rule of route resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Match"
        ]
      }
    }
  }
}