AWS::LookoutMetrics::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).

AWS::LookoutMetrics::AnomalyDetector

The AWS::LookoutMetrics::AnomalyDetector type creates an anomaly detector.

Syntax

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

JSON

{
  "Type" : "AWS::LookoutMetrics::AnomalyDetector",
  "Properties" : {
      "AnomalyDetectorConfig" : AnomalyDetectorConfig,
      "AnomalyDetectorDescription" : String,
      "AnomalyDetectorName" : String,
      "KmsKeyArn" : String,
      "MetricSetList" : [ MetricSet, ... ]
    }
}

YAML

Type: AWS::LookoutMetrics::AnomalyDetector
Properties:
  AnomalyDetectorConfig: 
    AnomalyDetectorConfig
  AnomalyDetectorDescription: String
  AnomalyDetectorName: String
  KmsKeyArn: String
  MetricSetList: 
    - MetricSet

Properties

AnomalyDetectorConfig

Contains information about the configuration of the anomaly detector.

Required: Yes

Type: AnomalyDetectorConfig

Update requires: No interruption

AnomalyDetectorDescription

A description of the detector.

Required: No

Type: String

Pattern: .*\S.*

Maximum: 256

Update requires: No interruption

AnomalyDetectorName

The name of the detector.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

Minimum: 1

Maximum: 63

Update requires: Replacement

KmsKeyArn

The ARN of the KMS key to use to encrypt your data.

Required: No

Type: String

Pattern: arn:aws.*:kms:.*:[0-9]{12}:key/.*

Minimum: 20

Maximum: 2048

Update requires: No interruption

MetricSetList

The detector's dataset.

Required: Yes

Type: Array of MetricSet

Minimum: 1

Maximum: 1

Update requires: No interruption

Return values

Ref

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

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 detector. For example, arn:aws:lookoutmetrics:us-east-2:123456789012:AnomalyDetector:my-detector