Probe class

Resource for managing an AWS Network Monitor Probe.

Example Usage

Basic Usage

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

const example = new aws.networkmonitor.Monitor("example", {
    aggregationPeriod: 30,
    monitorName: "example",
});
const exampleProbe = new aws.networkmonitor.Probe("example", {
    monitorName: example.monitorName,
    destination: "127.0.0.1",
    destinationPort: 80,
    protocol: "TCP",
    sourceArn: exampleAwsSubnet.arn,
    packetSize: 200,
});
import pulumi
import pulumi_aws as aws

example = aws.networkmonitor.Monitor("example",
    aggregation_period=30,
    monitor_name="example")
example_probe = aws.networkmonitor.Probe("example",
    monitor_name=example.monitor_name,
    destination="127.0.0.1",
    destination_port=80,
    protocol="TCP",
    source_arn=example_aws_subnet["arn"],
    packet_size=200)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.NetworkMonitor.Monitor("example", new()
    {
        AggregationPeriod = 30,
        MonitorName = "example",
    });

    var exampleProbe = new Aws.NetworkMonitor.Probe("example", new()
    {
        MonitorName = example.MonitorName,
        Destination = "127.0.0.1",
        DestinationPort = 80,
        Protocol = "TCP",
        SourceArn = exampleAwsSubnet.Arn,
        PacketSize = 200,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networkmonitor.NewMonitor(ctx, "example", &networkmonitor.MonitorArgs{
			AggregationPeriod: pulumi.Int(30),
			MonitorName:       pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = networkmonitor.NewProbe(ctx, "example", &networkmonitor.ProbeArgs{
			MonitorName:     example.MonitorName,
			Destination:     pulumi.String("127.0.0.1"),
			DestinationPort: pulumi.Int(80),
			Protocol:        pulumi.String("TCP"),
			SourceArn:       pulumi.Any(exampleAwsSubnet.Arn),
			PacketSize:      pulumi.Int(200),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_networkmonitor_monitor" "example" {
  aggregation_period = 30
  monitor_name       = "example"
}
resource "aws_networkmonitor_probe" "example" {
  monitor_name     = aws_networkmonitor_monitor.example.monitor_name
  destination      = "127.0.0.1"
  destination_port = 80
  protocol         = "TCP"
  source_arn       = exampleAwsSubnet.arn
  packet_size      = 200
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmonitor.Monitor;
import com.pulumi.aws.networkmonitor.MonitorArgs;
import com.pulumi.aws.networkmonitor.Probe;
import com.pulumi.aws.networkmonitor.ProbeArgs;
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 example = new Monitor("example", MonitorArgs.builder()
            .aggregationPeriod(30)
            .monitorName("example")
            .build());

        var exampleProbe = new Probe("exampleProbe", ProbeArgs.builder()
            .monitorName(example.monitorName())
            .destination("127.0.0.1")
            .destinationPort(80)
            .protocol("TCP")
            .sourceArn(exampleAwsSubnet.arn())
            .packetSize(200)
            .build());

    }
}
resources:
  example:
    type: aws:networkmonitor:Monitor
    properties:
      aggregationPeriod: 30
      monitorName: example
  exampleProbe:
    type: aws:networkmonitor:Probe
    name: example
    properties:
      monitorName: ${example.monitorName}
      destination: 127.0.0.1
      destinationPort: 80
      protocol: TCP
      sourceArn: ${exampleAwsSubnet.arn}
      packetSize: 200

Import

Using pulumi import, import aws.networkmonitor.Probe using the monitor name and probe id. For example:

$ pulumi import aws:networkmonitor/probe:Probe example monitor-7786087912324693644,probe-3qm8p693i4fi1h8lqylzkbp42e

Constructors

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

Properties

addressFamily ↔ Output<String>
latefinal
arn ↔ Output<String>
The ARN of the attachment.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
destination ↔ Output<String>
The destination IP address. This must be either IPV4 or IPV6.
latefinal
destinationPort ↔ Output<int?>
The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
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
monitorName ↔ Output<String>
The name of the monitor.
latefinal
packetSize ↔ Output<int>
The size of the packets sent between the source and destination. This must be a number between 56 and 8500.
latefinal
probeId ↔ Output<String>
latefinal
protocol ↔ Output<String>
The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.
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
sourceArn ↔ Output<String>
The ARN of the subnet.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value tags for the monitor. 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>>
A 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
vpcId ↔ Output<String>
latefinal

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, {ProbeState? state, CustomResourceOptions? options}) → Probe
Gets an existing Probe resource's state with the given name and id.