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	awscc.ec2.network_insights_paths

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
network_insights_path_id	string
region	string	AWS region.

For more information, see AWS::EC2::NetworkInsightsPath.

Methods

Name	Resource	Accessible by	Required Params
create_resource	network_insights_paths	INSERT	Protocol, Source, region
delete_resource	network_insights_paths	DELETE	Identifier, region
update_resource	network_insights_paths	UPDATE	Identifier, PatchDocument, region
list_resources	network_insights_paths_list_only	SELECT	region
get_resource	network_insights_paths	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.ec2.network_insights_paths
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ network_insights_path_id }}';

list (identifiers only)

Lists all network_insights_paths in a region.

SELECT
  region,
  network_insights_path_id
FROM awscc.ec2.network_insights_paths_list_only
WHERE
  region = '{{ region }}';

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 awscc.ec2.network_insights_paths (
  Source,
  Protocol,
  region
)
SELECT
  '{{ source }}',
  '{{ protocol }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.network_insights_paths (
  SourceIp,
  FilterAtSource,
  FilterAtDestination,
  DestinationIp,
  Source,
  Destination,
  Protocol,
  DestinationPort,
  Tags,
  region
)
SELECT
  '{{ source_ip }}',
  '{{ filter_at_source }}',
  '{{ filter_at_destination }}',
  '{{ destination_ip }}',
  '{{ source }}',
  '{{ destination }}',
  '{{ protocol }}',
  '{{ destination_port }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: source_ip
      value: '{{ source_ip }}'
    - name: filter_at_source
      value:
        source_address: null
        source_port_range:
          from_port: '{{ from_port }}'
          to_port: '{{ to_port }}'
        destination_address: null
        destination_port_range: null
    - name: filter_at_destination
      value: null
    - name: destination_ip
      value: null
    - name: source
      value: '{{ source }}'
    - name: destination
      value: '{{ destination }}'
    - name: protocol
      value: '{{ protocol }}'
    - name: destination_port
      value: '{{ destination_port }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.network_insights_paths
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ network_insights_path_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.network_insights_paths
WHERE
  Identifier = '{{ network_insights_path_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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