Use DATASOURCE::VPC::RouteEntries to query routes - Resource Orchestration Service

Syntax

{
  "Type": "DATASOURCE::VPC::RouteEntries",
  "Properties": {
    "NextHopType": String,
    "RouteEntryId": String,
    "RouteTableId": String,
    "IpVersion": String,
    "RouteEntryName": String,
    "RouteEntryType": String,
    "NextHopId": String,
    "DestinationCidrBlock": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
NextHopType	String	No	Yes	The next hop type.	Valid values: Instance (default): Elastic Compute Service (ECS) instance HaVip: high-availability virtual IP address (HAVIP) VpnGateway: VPN gateway NatGateway: NAT gateway NetworkInterface: secondary elastic network interface (ENI) RouterInterface: router interface IPv6Gateway: IPv6 gateway Attachment: transit router
RouteEntryId	String	No	Yes	The route entry ID.	None.
RouteTableId	String	Yes	Yes	The route table ID.	None.
IpVersion	String	No	Yes	The IP version.	Valid values: IPv4 IPv6
RouteEntryName	String	No	Yes	The route entry name.	None.
RouteEntryType	String	No	Yes	The route entry type.	Valid values: Custom: custom route System: system route BGP: BGP route CEN: Cloud Enterprise Network (CEN) route
NextHopId	String	No	Yes	The next hop ID.	None.
DestinationCidrBlock	String	No	Yes	The destination CIDR block of the route entry.	Both IPv4 and IPv6 CIDR blocks are supported. Example: 192.168.2.0/24.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): Data source resources are not refreshed when the stack is updated. Always: Data source resources are refreshed when the stack is updated.

Return values (Fn::GetAtt)

RouteEntryIds: the route entry IDs.
RouteEntries: the route entry details.

Property	Type	Description	Constraint
RouteEntryIds	List	The route entry IDs.	Example: `['rte-bp1mnnr2al0naomnp**', 'rte-hu2mnnr3al0naomnp**']`.
RouteEntries	List	The route entry details.	None.
Status	String	The route entry status.	Valid values: Pending: The route is being configured. Available: The route is available. Modifying: The route is being modified.
Type	String	The route entry type.	Valid values: Custom: custom route System: system route BGP: BGP route CEN: CEN route
IpVersion	String	The IP version.	Valid values: IPv4 IPv6
Description	String	The route entry description.	None.
RouteEntryName	String	The route entry name.	None.
DestinationCidrBlock	String	The destination CIDR block of the route entry.	None.
RouteEntryId	String	The route entry ID.	None.
RouteTableId	String	The route table ID.	None.
NextHops	List	The next hop details.	Example: `[ { "NextHopId": "eni-bp16v0fuhulfl5e1****", "NextHopRelatedInfo": {}, "NextHopType": "NetworkInterface" }]`.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RouteTableId": {
      "Type": "String",
      "Description": "The ID of the route."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::RouteEntries",
      "Properties": {
        "RouteTableId": {
          "Ref": "RouteTableId"
        }
      }
    }
  },
  "Outputs": {
    "RouteEntries": {
      "Description": "The list of The route entries.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteEntries"
        ]
      }
    },
    "RouteEntryIds": {
      "Description": "the list of the route entry ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteEntryIds"
        ]
      }
    }
  }
}