network_insights_paths

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

Overview

Name	network_insights_paths
Type	Resource
Id	aws.ec2.network_insights_paths

Fields

The following fields are returned by SELECT queries:

describe_network_insights_paths

Name	Datatype	Description
created_date	string	The time stamp when the path was created.
destination	string	The ID of the destination.
destination_arn	string	The Amazon Resource Name (ARN) of the destination.
destination_ip	string	The IP address of the destination.
destination_port	integer	The destination port.
filter_at_destination	string	Scopes the analysis to network paths that match specific filters at the destination.
filter_at_source	string	Scopes the analysis to network paths that match specific filters at the source.
network_insights_path_arn	string	The Amazon Resource Name (ARN) of the path.
network_insights_path_id	string	The ID of the path.
protocol	string	The protocol.
source	string	The ID of the source.
source_arn	string	The Amazon Resource Name (ARN) of the source.
source_ip	string	The IP address of the source.
tags	string	The tags associated with the path.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_network_insights_paths	select	region	NetworkInsightsPathId, Filter, MaxResults, DryRun, NextToken	Describes one or more of your paths.
create_network_insights_path	insert	ClientToken, region	SourceIp, DestinationIp, Source, Destination, Protocol, DestinationPort, TagSpecification, DryRun, FilterAtSource, FilterAtDestination	Creates a path to analyze for reachability. Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the Reachability Analyzer Guide.
delete_network_insights_path	delete	NetworkInsightsPathId, region	DryRun	Deletes the specified path.

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
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
NetworkInsightsPathId	string	The ID of the path.
region	string	AWS region (default: us-east-1)
Destination	string	The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
DestinationIp	string	The IP address of the destination.
DestinationPort	integer	The destination port.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	The filters. The following are the possible values: destination - The ID of the resource. filter-at-source.source-address - The source IPv4 address at the source. filter-at-source.source-port-range - The source port range at the source. filter-at-source.destination-address - The destination IPv4 address at the source. filter-at-source.destination-port-range - The destination port range at the source. filter-at-destination.source-address - The source IPv4 address at the destination. filter-at-destination.source-port-range - The source port range at the destination. filter-at-destination.destination-address - The destination IPv4 address at the destination. filter-at-destination.destination-port-range - The destination port range at the destination. protocol - The protocol. source - The ID of the resource.
FilterAtDestination	object	Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address.
FilterAtSource	object	Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NetworkInsightsPathId	array	The IDs of the paths.
NextToken	string	The token for the next page of results.
Protocol	string	The protocol.
Source	string	The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
SourceIp	string	The IP address of the source.
TagSpecification	array	The tags to add to the path.

SELECT examples

describe_network_insights_paths

Describes one or more of your paths.

SELECT
created_date,
destination,
destination_arn,
destination_ip,
destination_port,
filter_at_destination,
filter_at_source,
network_insights_path_arn,
network_insights_path_id,
protocol,
source,
source_arn,
source_ip,
tags
FROM aws.ec2.network_insights_paths
WHERE region = '{{ region }}' -- required
AND NetworkInsightsPathId = '{{ NetworkInsightsPathId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND DryRun = '{{ DryRun }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_network_insights_path

Creates a path to analyze for reachability. Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the Reachability Analyzer Guide.

INSERT INTO aws.ec2.network_insights_paths (
ClientToken,
region,
SourceIp,
DestinationIp,
Source,
Destination,
Protocol,
DestinationPort,
TagSpecification,
DryRun,
FilterAtSource,
FilterAtDestination
)
SELECT 
'{{ ClientToken }}',
'{{ region }}',
'{{ SourceIp }}',
'{{ DestinationIp }}',
'{{ Source }}',
'{{ Destination }}',
'{{ Protocol }}',
'{{ DestinationPort }}',
'{{ TagSpecification }}',
'{{ DryRun }}',
'{{ FilterAtSource }}',
'{{ FilterAtDestination }}'
RETURNING
created_date,
destination,
destination_arn,
destination_ip,
destination_port,
filter_at_destination,
filter_at_source,
network_insights_path_arn,
network_insights_path_id,
protocol,
source,
source_arn,
source_ip,
tags
;

Manifest

# Description fields are for documentation purposes
- name: network_insights_paths
props:
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: Required parameter for the network_insights_paths resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the network_insights_paths resource.
  - name: SourceIp
    value: "{{ SourceIp }}"
    description: The IP address of the source.
    description: The IP address of the source.
  - name: DestinationIp
    value: "{{ DestinationIp }}"
    description: The IP address of the destination.
    description: The IP address of the destination.
  - name: Source
    value: "{{ Source }}"
    description: The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
    description: The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
  - name: Destination
    value: "{{ Destination }}"
    description: The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
    description: The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
  - name: Protocol
    value: "{{ Protocol }}"
    description: The protocol.
    description: The protocol.
  - name: DestinationPort
    value: {{ DestinationPort }}
    description: The destination port.
    description: The destination port.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to add to the path.
    description: The tags to add to the path.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - name: FilterAtSource
    value: "{{ FilterAtSource }}"
    description: Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.
    description: Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.
  - name: FilterAtDestination
    value: "{{ FilterAtDestination }}"
    description: Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address.
    description: Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address.

DELETE examples

delete_network_insights_path

Deletes the specified path.

DELETE FROM aws.ec2.network_insights_paths
WHERE NetworkInsightsPathId = '{{ NetworkInsightsPathId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;