[ aws . networkmanager ]

get-network-routes

Description

Gets the network routes of the specified global network.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-network-routes
--global-network-id <value>
--route-table-identifier <value>
[--exact-cidr-matches <value>]
[--longest-prefix-matches <value>]
[--subnet-of-matches <value>]
[--supernet-of-matches <value>]
[--prefix-list-ids <value>]
[--states <value>]
[--types <value>]
[--destination-filters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--global-network-id (string)

The ID of the global network.

--route-table-identifier (structure)

The ID of the route table.

TransitGatewayRouteTableArn -> (string)

The ARN of the transit gateway route table.

CoreNetworkSegmentEdge -> (structure)

The segment edge in a core network.

CoreNetworkId -> (string)

The ID of a core network.

SegmentName -> (string)

The name of the segment edge.

EdgeLocation -> (string)

The Region where the segment edge is located.

Shorthand Syntax:

TransitGatewayRouteTableArn=string,CoreNetworkSegmentEdge={CoreNetworkId=string,SegmentName=string,EdgeLocation=string}

JSON Syntax:

{
  "TransitGatewayRouteTableArn": "string",
  "CoreNetworkSegmentEdge": {
    "CoreNetworkId": "string",
    "SegmentName": "string",
    "EdgeLocation": "string"
  }
}

--exact-cidr-matches (list)

An exact CIDR block.

(string)

Syntax:

"string" "string" ...

--longest-prefix-matches (list)

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

(string)

Syntax:

"string" "string" ...

--subnet-of-matches (list)

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

(string)

Syntax:

"string" "string" ...

--supernet-of-matches (list)

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.

(string)

Syntax:

"string" "string" ...

--prefix-list-ids (list)

The IDs of the prefix lists.

(string)

Syntax:

"string" "string" ...

--states (list)

The route states.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  ACTIVE
  BLACKHOLE

--types (list)

The route types.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  PROPAGATED
  STATIC

--destination-filters (map)

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

key -> (string)

value -> (list)

(string)

Shorthand Syntax:

KeyName1=string,string,KeyName2=string,string

JSON Syntax:

{"string": ["string", ...]
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

RouteTableArn -> (string)

The ARN of the route table.

CoreNetworkSegmentEdge -> (structure)

Describes a core network segment edge.

CoreNetworkId -> (string)

The ID of a core network.

SegmentName -> (string)

The name of the segment edge.

EdgeLocation -> (string)

The Region where the segment edge is located.

RouteTableType -> (string)

The route table type.

RouteTableTimestamp -> (timestamp)

The route table creation time.

NetworkRoutes -> (list)

The network routes.

(structure)

Describes a network route.

DestinationCidrBlock -> (string)

A unique identifier for the route, such as a CIDR block.

Destinations -> (list)

The destinations.

(structure)

Describes the destination of a network route.

CoreNetworkAttachmentId -> (string)

The ID of a core network attachment.

TransitGatewayAttachmentId -> (string)

The ID of the transit gateway attachment.

SegmentName -> (string)

The name of the segment.

EdgeLocation -> (string)

The edge location for the network destination.

ResourceType -> (string)

The resource type.

ResourceId -> (string)

The ID of the resource.

PrefixListId -> (string)

The ID of the prefix list.

State -> (string)

The route state. The possible values are active and blackhole .

Type -> (string)

The route type. The possible values are propagated and static .