network_insights_paths

Creates, updates, deletes or gets a network_insights_path resource or lists network_insights_paths in a region

Overview

Name	network_insights_paths
Type	Resource
Description	Resource schema for AWS::EC2::NetworkInsightsPath
Id	aws.ec2.network_insights_paths

Fields

Name	Datatype	Description
network_insights_path_id	string
network_insights_path_arn	string
created_date	string
source_ip	string
filter_at_source	object
filter_at_destination	object
destination_ip	string
source	string
destination	string
source_arn	string
destination_arn	string
protocol	string
destination_port	integer
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Protocol, Source, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all network_insights_paths in a region.

SELECT
region,
network_insights_path_id,
network_insights_path_arn,
created_date,
source_ip,
filter_at_source,
filter_at_destination,
destination_ip,
source,
destination,
source_arn,
destination_arn,
protocol,
destination_port,
tags
FROM aws.ec2.network_insights_paths
WHERE region = 'us-east-1';

Gets all properties from an individual network_insights_path.

SELECT
region,
network_insights_path_id,
network_insights_path_arn,
created_date,
source_ip,
filter_at_source,
filter_at_destination,
destination_ip,
source,
destination,
source_arn,
destination_arn,
protocol,
destination_port,
tags
FROM aws.ec2.network_insights_paths
WHERE region = 'us-east-1' AND data__Identifier = '<NetworkInsightsPathId>';

INSERT example

Use the following StackQL query and manifest file to create a new network_insights_path resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ec2.network_insights_paths (
 Source,
 Protocol,
 region
)
SELECT 
'{{ Source }}',
 '{{ Protocol }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.network_insights_paths (
 SourceIp,
 FilterAtSource,
 FilterAtDestination,
 DestinationIp,
 Source,
 Destination,
 Protocol,
 DestinationPort,
 Tags,
 region
)
SELECT 
 '{{ SourceIp }}',
 '{{ FilterAtSource }}',
 '{{ FilterAtDestination }}',
 '{{ DestinationIp }}',
 '{{ Source }}',
 '{{ Destination }}',
 '{{ Protocol }}',
 '{{ DestinationPort }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: network_insights_path
    props:
      - name: SourceIp
        value: '{{ SourceIp }}'
      - name: FilterAtSource
        value:
          SourceAddress: null
          SourcePortRange:
            FromPort: '{{ FromPort }}'
            ToPort: '{{ ToPort }}'
          DestinationAddress: null
          DestinationPortRange: null
      - name: FilterAtDestination
        value: null
      - name: DestinationIp
        value: null
      - name: Source
        value: '{{ Source }}'
      - name: Destination
        value: '{{ Destination }}'
      - name: Protocol
        value: '{{ Protocol }}'
      - name: DestinationPort
        value: '{{ DestinationPort }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.network_insights_paths
WHERE data__Identifier = '<NetworkInsightsPathId>'
AND region = 'us-east-1';

Permissions

To operate on the network_insights_paths resource, the following permissions are required:

Create

ec2:CreateNetworkInsightsPath,
ec2:CreateTags

Delete

ec2:DeleteNetworkInsightsPath,
ec2:DeleteTags

Read

ec2:DescribeNetworkInsightsPaths

List

ec2:DescribeNetworkInsightsPaths

Update

ec2:DescribeNetworkInsightsPaths,
ec2:CreateTags,
ec2:DeleteTags