Package com.pulumi.aws.amp

Class AnomalyDetector

  • public class AnomalyDetector
extends com.pulumi.resources.CustomResource
    Manages an AWS AMP (Managed Prometheus) Anomaly Detector. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.amp.Workspace;
 import com.pulumi.aws.amp.AnomalyDetector;
 import com.pulumi.aws.amp.AnomalyDetectorArgs;
 import com.pulumi.aws.amp.inputs.AnomalyDetectorConfigurationArgs;
 import com.pulumi.aws.amp.inputs.AnomalyDetectorConfigurationRandomCutForestArgs;
 import com.pulumi.aws.amp.inputs.AnomalyDetectorMissingDataActionArgs;
 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 Workspace("example");
 
         var exampleAnomalyDetector = new AnomalyDetector("exampleAnomalyDetector", AnomalyDetectorArgs.builder()
             .configuration(AnomalyDetectorConfigurationArgs.builder()
                 .randomCutForest(AnomalyDetectorConfigurationRandomCutForestArgs.builder()
                     .query("avg(up)")
                     .build())
                 .build())
             .missingDataAction(AnomalyDetectorMissingDataActionArgs.builder()
                 .skip(true)
                 .build())
             .alias("example")
             .workspaceId(example.id())
             .build());
 
     }
 }
    ### With evaluation interval and labels 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.amp.Workspace;
 import com.pulumi.aws.amp.AnomalyDetector;
 import com.pulumi.aws.amp.AnomalyDetectorArgs;
 import com.pulumi.aws.amp.inputs.AnomalyDetectorConfigurationArgs;
 import com.pulumi.aws.amp.inputs.AnomalyDetectorConfigurationRandomCutForestArgs;
 import com.pulumi.aws.amp.inputs.AnomalyDetectorConfigurationRandomCutForestIgnoreNearExpectedFromAboveArgs;
 import com.pulumi.aws.amp.inputs.AnomalyDetectorConfigurationRandomCutForestIgnoreNearExpectedFromBelowArgs;
 import com.pulumi.aws.amp.inputs.AnomalyDetectorMissingDataActionArgs;
 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 Workspace("example");
 
         var exampleAnomalyDetector = new AnomalyDetector("exampleAnomalyDetector", AnomalyDetectorArgs.builder()
             .configuration(AnomalyDetectorConfigurationArgs.builder()
                 .randomCutForest(AnomalyDetectorConfigurationRandomCutForestArgs.builder()
                     .ignoreNearExpectedFromAbove(AnomalyDetectorConfigurationRandomCutForestIgnoreNearExpectedFromAboveArgs.builder()
                         .ratio(1.5)
                         .build())
                     .ignoreNearExpectedFromBelow(AnomalyDetectorConfigurationRandomCutForestIgnoreNearExpectedFromBelowArgs.builder()
                         .amount(2.0)
                         .build())
                     .query("avg(up)")
                     .sampleSize(256)
                     .shingleSize(4)
                     .build())
                 .build())
             .missingDataAction(AnomalyDetectorMissingDataActionArgs.builder()
                 .markAsAnomaly(true)
                 .build())
             .alias("example")
             .workspaceId(example.id())
             .evaluationIntervalInSeconds(120)
             .labels(Map.ofEntries(
                 Map.entry("env", "production"),
                 Map.entry("team", "platform")
             ))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` - (String) ID of the Anomaly Detector. * `workspaceId` - (String) ID of the AMP workspace containing the Anomaly Detector. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import AMP (Managed Prometheus) Anomaly Detector using a comma-delimited string combining `id` and `workspaceId`. For example: ```sh $ pulumi import aws:amp/anomalyDetector:AnomalyDetector example ad-12345678-abcd-1234-abcd-123456789012,ws-12345678-abcd-1234-abcd-123456789012 ```

    • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> alias()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<AnomalyDetectorConfiguration> configuration()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.lang.Integer> evaluationIntervalInSeconds()  
      static AnomalyDetector get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AnomalyDetectorState 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.util.Map<java.lang.String,​java.lang.String>> labels()  
      com.pulumi.core.Output<AnomalyDetectorMissingDataAction> missingDataAction()  
      com.pulumi.core.Output<java.lang.String> region()  
      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.util.Optional<AnomalyDetectorTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.String> workspaceId()  

      • 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

      • AnomalyDetector

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

      • AnomalyDetector

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

      • AnomalyDetector

        public AnomalyDetector​(java.lang.String name,
                       AnomalyDetectorArgs 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

      • alias

        public com.pulumi.core.Output<java.lang.String> alias()
        Returns:
        Name of the anomaly detector.

      • arn

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

      • configuration

        public com.pulumi.core.Output<AnomalyDetectorConfiguration> configuration()
        Returns:
        Configuration block for the anomaly detector algorithm. See `configuration` below.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        RFC3339 timestamp of when the anomaly detector was created.

      • evaluationIntervalInSeconds

        public com.pulumi.core.Output<java.lang.Integer> evaluationIntervalInSeconds()
        Returns:
        Interval in seconds at which the anomaly detector evaluates data.

      • labels

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> labels()
        Returns:
        Map of label key-value pairs used to scope the anomaly detector to specific time series.

      • missingDataAction

        public com.pulumi.core.Output<AnomalyDetectorMissingDataAction> missingDataAction()
        Returns:
        Configuration block for the action to take when data is missing. See `missingDataAction` below.

      • 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.

      • tags

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

      • tagsAll

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

      • workspaceId

        public com.pulumi.core.Output<java.lang.String> workspaceId()
        Returns:
        ID of the AMP workspace in which to create the anomaly detector. The following arguments are optional:

      • get

        public static AnomalyDetector get​(java.lang.String name,
                                  com.pulumi.core.Output<java.lang.String> id,
                                  @Nullable
                                  AnomalyDetectorState 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.