route_analysis

Creates, updates, deletes, gets or lists a route_analysis resource.

Overview

Name	route_analysis
Type	Resource
Id	aws.networkmanager.route_analysis

Fields

The following fields are returned by SELECT queries:

get_route_analysis

Name	Datatype	Description
destination	object	The destination.
forward_path	object	The forward path.
global_network_id	string	The ID of the global network. (pattern: <code>[\s\S]*</code>)
include_return_path	boolean	Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
owner_account_id	string	The ID of the AWS account that created the route analysis. (pattern: <code>[\s\S]*</code>)
return_path	object	The return path.
route_analysis_id	string	The ID of the route analysis. (pattern: <code>[\s\S]*</code>)
source	object	The source.
start_timestamp	string (date-time)	The time that the analysis started.
status	string	The status of the route analysis. (RUNNING, COMPLETED, FAILED)
use_middleboxes	boolean	Indicates whether to include the location of middlebox appliances in the route analysis.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_route_analysis	select	global_network_id, route_analysis_id, region		Gets information about the specified route analysis.
start_route_analysis	exec	global_network_id, region, Source, Destination		Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
global_network_id	string	The ID of the global network.
region	string	AWS region (default: us-east-1)
route_analysis_id	string	The ID of the route analysis.

SELECT examples

get_route_analysis

Gets information about the specified route analysis.

SELECT
destination,
forward_path,
global_network_id,
include_return_path,
owner_account_id,
return_path,
route_analysis_id,
source,
start_timestamp,
status,
use_middleboxes
FROM aws.networkmanager.route_analysis
WHERE global_network_id = '{{ global_network_id }}' -- required
AND route_analysis_id = '{{ route_analysis_id }}' -- required
AND region = '{{ region }}' -- required
;

Lifecycle Methods

start_route_analysis

Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

EXEC aws.networkmanager.route_analysis.start_route_analysis 
@global_network_id='{{ global_network_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Source": "{{ Source }}", 
"Destination": "{{ Destination }}", 
"IncludeReturnPath": {{ IncludeReturnPath }}, 
"UseMiddleboxes": {{ UseMiddleboxes }}
}'
;