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

Fields

get (all properties)

Name	Datatype	Description
status	string
▶return_path_components	array
network_insights_analysis_id	string
filter_out_arns	array
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.

list (identifiers only)

Name	Datatype	Description
network_insights_analysis_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	network_insights_analyses	INSERT	NetworkInsightsPathId, region
delete_resource	network_insights_analyses	DELETE	Identifier, region
update_resource	network_insights_analyses	UPDATE	Identifier, PatchDocument, region
list_resources	network_insights_analyses_list_only	SELECT	region
get_resource	network_insights_analyses	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual network_insights_analysis.

SELECT
  region,
  status,
  return_path_components,
  network_insights_analysis_id,
  filter_out_arns,
  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 awscc.ec2.network_insights_analyses
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ network_insights_analysis_id }}';

list (identifiers only)

Lists all network_insights_analyses in a region.

SELECT
  region,
  network_insights_analysis_id
FROM awscc.ec2.network_insights_analyses_list_only
WHERE
  region = '{{ region }}';

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 awscc.ec2.network_insights_analyses (
  NetworkInsightsPathId,
  region
)
SELECT
  '{{ network_insights_path_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.network_insights_analyses (
  FilterOutArns,
  NetworkInsightsPathId,
  FilterInArns,
  AdditionalAccounts,
  Tags,
  region
)
SELECT
  '{{ filter_out_arns }}',
  '{{ network_insights_path_id }}',
  '{{ filter_in_arns }}',
  '{{ additional_accounts }}',
  '{{ 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_analysis
  props:
    - name: filter_out_arns
      value:
        - '{{ filter_out_arns[0] }}'
    - name: network_insights_path_id
      value: '{{ network_insights_path_id }}'
    - name: filter_in_arns
      value:
        - null
    - name: additional_accounts
      value:
        - '{{ additional_accounts[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.network_insights_analyses
WHERE
  Identifier = '{{ network_insights_analysis_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_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