@pulumi/aws/ec2/getNetworkInsightsAnalysis.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * `aws.ec2.NetworkInsightsAnalysis` provides details about a specific Network Insights Analysis.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.ec2.getNetworkInsightsAnalysis({
 *     networkInsightsAnalysisId: exampleAwsEc2NetworkInsightsAnalysis.id,
 * });
 * ```
 */
export declare function getNetworkInsightsAnalysis(args?: GetNetworkInsightsAnalysisArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkInsightsAnalysisResult>;
/**
 * A collection of arguments for invoking getNetworkInsightsAnalysis.
 */
export interface GetNetworkInsightsAnalysisArgs {
    /**
     * Configuration block(s) for filtering. Detailed below.
     *
     * The arguments of this data source act as filters for querying the available
     * Network Insights Analyzes. The given filters must match exactly one Network Insights Analysis
     * whose data will be exported as attributes.
     */
    filters?: inputs.ec2.GetNetworkInsightsAnalysisFilter[];
    /**
     * ID of the Network Insights Analysis to select.
     */
    networkInsightsAnalysisId?: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getNetworkInsightsAnalysis.
 */
export interface GetNetworkInsightsAnalysisResult {
    /**
     * Potential intermediate components of a feasible path.
     */
    readonly alternatePathHints: outputs.ec2.GetNetworkInsightsAnalysisAlternatePathHint[];
    /**
     * ARN of the selected Network Insights Analysis.
     */
    readonly arn: string;
    /**
     * Explanation codes for an unreachable path.
     */
    readonly explanations: outputs.ec2.GetNetworkInsightsAnalysisExplanation[];
    /**
     * ARNs of the AWS resources that the path must traverse.
     */
    readonly filterInArns: string[];
    readonly filters?: outputs.ec2.GetNetworkInsightsAnalysisFilter[];
    /**
     * The components in the path from source to destination.
     */
    readonly forwardPathComponents: outputs.ec2.GetNetworkInsightsAnalysisForwardPathComponent[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly networkInsightsAnalysisId: string;
    /**
     * The ID of the path.
     */
    readonly networkInsightsPathId: string;
    /**
     * Set to `true` if the destination was reachable.
     */
    readonly pathFound: boolean;
    readonly region: string;
    /**
     * The components in the path from destination to source.
     */
    readonly returnPathComponents: outputs.ec2.GetNetworkInsightsAnalysisReturnPathComponent[];
    /**
     * Date/time the analysis was started.
     */
    readonly startDate: string;
    /**
     * Status of the analysis. `succeeded` means the analysis was completed, not that a path was found, for that see `pathFound`.
     */
    readonly status: string;
    /**
     * Message to provide more context when the `status` is `failed`.
     */
    readonly statusMessage: string;
    readonly tags: {
        [key: string]: string;
    };
    /**
     * Warning message.
     */
    readonly warningMessage: string;
}
/**
 * `aws.ec2.NetworkInsightsAnalysis` provides details about a specific Network Insights Analysis.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.ec2.getNetworkInsightsAnalysis({
 *     networkInsightsAnalysisId: exampleAwsEc2NetworkInsightsAnalysis.id,
 * });
 * ```
 */
export declare function getNetworkInsightsAnalysisOutput(args?: GetNetworkInsightsAnalysisOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNetworkInsightsAnalysisResult>;
/**
 * A collection of arguments for invoking getNetworkInsightsAnalysis.
 */
export interface GetNetworkInsightsAnalysisOutputArgs {
    /**
     * Configuration block(s) for filtering. Detailed below.
     *
     * The arguments of this data source act as filters for querying the available
     * Network Insights Analyzes. The given filters must match exactly one Network Insights Analysis
     * whose data will be exported as attributes.
     */
    filters?: pulumi.Input<pulumi.Input<inputs.ec2.GetNetworkInsightsAnalysisFilterArgs>[]>;
    /**
     * ID of the Network Insights Analysis to select.
     */
    networkInsightsAnalysisId?: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}