AWS::APS::AnomalyDetector - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::APS::AnomalyDetector

Anomaly detection uses the Random Cut Forest algorithm for time-series analysis. The anomaly detector analyzes Amazon Managed Service for Prometheus metrics to identify unusual patterns and behaviors.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::APS::AnomalyDetector",
  "Properties" : {
      "Alias" : String,
      "Configuration" : AnomalyDetectorConfiguration,
      "EvaluationIntervalInSeconds" : Integer,
      "Labels" : [ Label, ... ],
      "MissingDataAction" : MissingDataAction,
      "Tags" : [ Tag, ... ],
      "Workspace" : String
    }
}

YAML

Type: AWS::APS::AnomalyDetector
Properties:
  Alias: String
  Configuration: 
    AnomalyDetectorConfiguration
  EvaluationIntervalInSeconds: Integer
  Labels: 
    - Label
  MissingDataAction: 
    MissingDataAction
  Tags: 
    - Tag
  Workspace: String

Properties

Alias

The user-friendly name of the anomaly detector.

Required: Yes

Type: String

Minimum: 1

Maximum: 128

Update requires: Replacement

Configuration

The algorithm configuration of the anomaly detector.

Required: Yes

Type: AnomalyDetectorConfiguration

Update requires: No interruption

EvaluationIntervalInSeconds

The frequency, in seconds, at which the anomaly detector evaluates metrics.

Required: No

Type: Integer

Update requires: No interruption

Labels

The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.

Required: No

Type: Array of Label

Update requires: No interruption

MissingDataAction

The action taken when data is missing during evaluation.

Required: No

Type: MissingDataAction

Update requires: No interruption

Tags

The tags applied to the anomaly detector.

Required: No

Type: Array of Tag

Update requires: No interruption

Workspace

An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.

Required: Yes

Type: String

Pattern: ^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:

{ "Ref": "Id" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the anomaly detector.