Skip to content

Get Network Routes

networkmanager_get_network_routes R Documentation

Gets the network routes of the specified global network

Description

Gets the network routes of the specified global network.

Usage

networkmanager_get_network_routes(GlobalNetworkId, RouteTableIdentifier,
  ExactCidrMatches, LongestPrefixMatches, SubnetOfMatches,
  SupernetOfMatches, PrefixListIds, States, Types, DestinationFilters)

Arguments

GlobalNetworkId

[required] The ID of the global network.

RouteTableIdentifier

[required] The ID of the route table.

ExactCidrMatches

An exact CIDR block.

LongestPrefixMatches

The most specific route that matches the traffic (longest prefix match).

SubnetOfMatches

The routes with a subnet that match the specified CIDR filter.

SupernetOfMatches

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

PrefixListIds

The IDs of the prefix lists.

States

The route states.

Types

The route types.

DestinationFilters

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

Value

A list with the following syntax:

list(
  RouteTableArn = "string",
  CoreNetworkSegmentEdge = list(
    CoreNetworkId = "string",
    SegmentName = "string",
    EdgeLocation = "string"
  ),
  RouteTableType = "TRANSIT_GATEWAY_ROUTE_TABLE"|"CORE_NETWORK_SEGMENT"|"NETWORK_FUNCTION_GROUP",
  RouteTableTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  NetworkRoutes = list(
    list(
      DestinationCidrBlock = "string",
      Destinations = list(
        list(
          CoreNetworkAttachmentId = "string",
          TransitGatewayAttachmentId = "string",
          SegmentName = "string",
          NetworkFunctionGroupName = "string",
          EdgeLocation = "string",
          ResourceType = "string",
          ResourceId = "string"
        )
      ),
      PrefixListId = "string",
      State = "ACTIVE"|"BLACKHOLE",
      Type = "PROPAGATED"|"STATIC"
    )
  )
)

Request syntax

svc$get_network_routes(
  GlobalNetworkId = "string",
  RouteTableIdentifier = list(
    TransitGatewayRouteTableArn = "string",
    CoreNetworkSegmentEdge = list(
      CoreNetworkId = "string",
      SegmentName = "string",
      EdgeLocation = "string"
    ),
    CoreNetworkNetworkFunctionGroup = list(
      CoreNetworkId = "string",
      NetworkFunctionGroupName = "string",
      EdgeLocation = "string"
    )
  ),
  ExactCidrMatches = list(
    "string"
  ),
  LongestPrefixMatches = list(
    "string"
  ),
  SubnetOfMatches = list(
    "string"
  ),
  SupernetOfMatches = list(
    "string"
  ),
  PrefixListIds = list(
    "string"
  ),
  States = list(
    "ACTIVE"|"BLACKHOLE"
  ),
  Types = list(
    "PROPAGATED"|"STATIC"
  ),
  DestinationFilters = list(
    list(
      "string"
    )
  )
)