Skip to content

Data Source: awsEc2NetworkInsightsAnalysis

awsEc2NetworkInsightsAnalysis provides details about a specific Network Insights Analysis.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsEc2NetworkInsightsAnalysis.DataAwsEc2NetworkInsightsAnalysis(
  this,
  "example",
  {
    networkInsightsAnalysisId:
      "${aws_ec2_network_insights_analysis.example.id}",
  }
);

Argument Reference

The arguments of this data source act as filters for querying the available Network Insights Analyses. The given filters must match exactly one Network Insights Analysis whose data will be exported as attributes.

  • networkInsightsAnalysisId - (Optional) ID of the Network Insights Analysis to select.
  • filter - (Optional) Configuration block(s) for filtering. Detailed below.

filter Configuration Block

The following arguments are supported by the filter configuration block:

  • name - (Required) Name of the filter field. Valid values can be found in the EC2 describeNetworkInsightsAnalyses API Reference.
  • values - (Required) Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • alternatePathHints - Potential intermediate components of a feasible path.
  • arn - ARN of the selected Network Insights Analysis.
  • explanations - Explanation codes for an unreachable path.
  • filterInArns - ARNs of the AWS resources that the path must traverse.
  • forwardPathComponents - The components in the path from source to destination.
  • networkInsightsPathId - The ID of the path.
  • pathFound - Set to true if the destination was reachable.
  • returnPathComponents - The components in the path from destination to source.
  • startDate - Date/time the analysis was started.
  • status - Status of the analysis. succeeded means the analysis was completed, not that a path was found, for that see pathFound.
  • statusMessage - Message to provide more context when the status is failed.
  • warningMessage - Warning message.