network_insights_analyses

Creates, updates, deletes or gets a network_insights_analysis resource or lists network_insights_analyses in a region

Overview

Name	network_insights_analyses
Type	Resource
Description	Resource schema for AWS::EC2::NetworkInsightsAnalysis
Id	aws.ec2.network_insights_analyses

Fields

Name	Datatype	Description
status	string
return_path_components	array
network_insights_analysis_id	string
network_insights_path_id	string
network_path_found	boolean
suggested_accounts	array
filter_in_arns	array
network_insights_analysis_arn	string
status_message	string
start_date	string
alternate_path_hints	array
explanations	array
forward_path_components	array
additional_accounts	array
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	NetworkInsightsPathId, 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_analyses in a region.

SELECT
region,
status,
return_path_components,
network_insights_analysis_id,
network_insights_path_id,
network_path_found,
suggested_accounts,
filter_in_arns,
network_insights_analysis_arn,
status_message,
start_date,
alternate_path_hints,
explanations,
forward_path_components,
additional_accounts,
tags
FROM aws.ec2.network_insights_analyses
WHERE region = 'us-east-1';

Gets all properties from an individual network_insights_analysis.

SELECT
region,
status,
return_path_components,
network_insights_analysis_id,
network_insights_path_id,
network_path_found,
suggested_accounts,
filter_in_arns,
network_insights_analysis_arn,
status_message,
start_date,
alternate_path_hints,
explanations,
forward_path_components,
additional_accounts,
tags
FROM aws.ec2.network_insights_analyses
WHERE region = 'us-east-1' AND data__Identifier = '<NetworkInsightsAnalysisId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ec2.network_insights_analyses (
 NetworkInsightsPathId,
 region
)
SELECT 
'{{ NetworkInsightsPathId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.network_insights_analyses (
 NetworkInsightsPathId,
 FilterInArns,
 AdditionalAccounts,
 Tags,
 region
)
SELECT 
 '{{ NetworkInsightsPathId }}',
 '{{ FilterInArns }}',
 '{{ AdditionalAccounts }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: network_insights_analysis
    props:
      - name: NetworkInsightsPathId
        value: '{{ NetworkInsightsPathId }}'
      - name: FilterInArns
        value:
          - '{{ FilterInArns[0] }}'
      - name: AdditionalAccounts
        value:
          - '{{ AdditionalAccounts[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Read

ec2:Describe*

Create

ec2:CreateTags,
ec2:StartNetworkInsightsAnalysis,
ec2:GetTransitGatewayRouteTablePropagations,
ec2:SearchTransitGatewayRoutes,
ec2:Describe*,
ec2:GetManagedPrefixListEntries,
elasticloadbalancing:Describe*,
directconnect:Describe*,
tiros:CreateQuery,
tiros:GetQueryAnswer,
tiros:GetQueryExplanation

Update

ec2:CreateTags,
ec2:Describe*,
ec2:DeleteTags

List

ec2:Describe*

Delete

ec2:DeleteNetworkInsightsAnalysis,
ec2:DeleteTags