Package com.pulumi.aws.networkmonitor

Class Probe

  • public class Probe
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Network Monitor Probe. ## Example Usage ### Basic Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.networkmonitor.Probe` using the monitor name and probe ID. For example: ```sh $ pulumi import aws:networkmonitor/probe:Probe example monitor-7786087912324693644,probe-3qm8p693i4fi1h8lqylzkbp42e ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Probe​(java.lang.String name)  
      Probe​(java.lang.String name, ProbeArgs args)  
      Probe​(java.lang.String name, ProbeArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> addressFamily()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> destination()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> destinationPort()  
      static Probe get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ProbeState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> monitorName()  
      com.pulumi.core.Output<java.lang.Integer> packetSize()  
      com.pulumi.core.Output<java.lang.String> probeId()  
      com.pulumi.core.Output<java.lang.String> protocol()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> sourceArn()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> vpcId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Probe

        public Probe​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Probe

        public Probe​(java.lang.String name,
             ProbeArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Probe

        public Probe​(java.lang.String name,
             ProbeArgs args,
             @Nullable
             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • addressFamily

        public com.pulumi.core.Output<java.lang.String> addressFamily()

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the attachment.

      • destination

        public com.pulumi.core.Output<java.lang.String> destination()
        Returns:
        The destination IP address. This must be either IPV4 or IPV6.

      • destinationPort

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> destinationPort()
        Returns:
        The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.

      • monitorName

        public com.pulumi.core.Output<java.lang.String> monitorName()
        Returns:
        The name of the monitor.

      • packetSize

        public com.pulumi.core.Output<java.lang.Integer> packetSize()
        Returns:
        The size of the packets sent between the source and destination. This must be a number between 56 and 8500.

      • probeId

        public com.pulumi.core.Output<java.lang.String> probeId()

      • protocol

        public com.pulumi.core.Output<java.lang.String> protocol()
        Returns:
        The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • sourceArn

        public com.pulumi.core.Output<java.lang.String> sourceArn()
        Returns:
        The ARN of the subnet.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • vpcId

        public com.pulumi.core.Output<java.lang.String> vpcId()

      • get

        public static Probe get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        ProbeState state,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.