NetworkInsightsPath class

Provides a Network Insights Path resource. Part of the "Reachability Analyzer" service in the AWS VPC console.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.ec2.NetworkInsightsPath("test", {
    source: source.id,
    destination: destination.id,
    protocol: "tcp",
});
import pulumi
import pulumi_aws as aws

test = aws.ec2.NetworkInsightsPath("test",
    source=source["id"],
    destination=destination["id"],
    protocol="tcp")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Ec2.NetworkInsightsPath("test", new()
    {
        Source = source.Id,
        Destination = destination.Id,
        Protocol = "tcp",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewNetworkInsightsPath(ctx, "test", &ec2.NetworkInsightsPathArgs{
			Source:      pulumi.Any(source.Id),
			Destination: pulumi.Any(destination.Id),
			Protocol:    pulumi.String("tcp"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_networkinsightspath" "test" {
  source      = source.id
  destination = destination.id
  protocol    = "tcp"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.NetworkInsightsPath;
import com.pulumi.aws.ec2.NetworkInsightsPathArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new NetworkInsightsPath("test", NetworkInsightsPathArgs.builder()
            .source(source.id())
            .destination(destination.id())
            .protocol("tcp")
            .build());

    }
}
resources:
  test:
    type: aws:ec2:NetworkInsightsPath
    properties:
      source: ${source.id}
      destination: ${destination.id}
      protocol: tcp

Import

Using pulumi import, import Network Insights Paths using the id. For example:

$ pulumi import aws:ec2/networkInsightsPath:NetworkInsightsPath test nip-00edfba169923aefd

Constructors

NetworkInsightsPath(String name, {NetworkInsightsPathArgs? args, CustomResourceOptions? options})
Creates a new NetworkInsightsPath. name The Pulumi resource name. args Arguments used to configure this NetworkInsightsPath. The set of arguments for NetworkInsightsPath. options Resource options controlling this resource's behavior.
NetworkInsightsPath.reference(String urn)
Creates a typed reference to an existing NetworkInsightsPath resource.

Properties

arn ↔ Output<String>
ARN of the Network Insights Path.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
destination ↔ Output<String?>
ID or ARN of the resource which is the destination of the path. Can be an Instance, Internet Gateway, Network Interface, Transit Gateway, VPC Endpoint, VPC Peering Connection or VPN Gateway. If the resource is in another account, you must specify an ARN. Either the destination argument or the destinationAddress argument in the filterAtSource block must be specified.
latefinal
destinationArn ↔ Output<String>
ARN of the destination.
latefinal
destinationIp ↔ Output<String?>
IP address of the destination resource.
latefinal
destinationPort ↔ Output<int?>
Destination port to analyze access to.
latefinal
filterAtDestination ↔ Output<NetworkInsightsPathFilterAtDestination>
Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify destinationIp. See below for details. Note that Terraform performs drift detection on this argument only when the value is provided.
latefinal
filterAtSource ↔ Output<NetworkInsightsPathFilterAtSource>
Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify sourceIp or destinationPort. See below for details. Note that Terraform performs drift detection on this argument only when the value is provided.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
protocol ↔ Output<String>
Protocol to use for analysis. Valid options are tcp or udp.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
source ↔ Output<String>
ID or ARN of the resource which is the source of the path. Can be an Instance, Internet Gateway, Network Interface, Transit Gateway, VPC Endpoint, VPC Peering Connection or VPN Gateway. If the resource is in another account, you must specify an ARN.
latefinal
sourceArn ↔ Output<String>
ARN of the source.
latefinal
sourceIp ↔ Output<String?>
IP address of the source resource.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {NetworkInsightsPathState? state, CustomResourceOptions? options}) → NetworkInsightsPath
Gets an existing NetworkInsightsPath resource's state with the given name and id.