AWS::LookoutMetrics::Alert
The AWS::LookoutMetrics::Alert
type creates an alert for an anomaly detector.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::LookoutMetrics::Alert", "Properties" : { "Action" :
Action
, "AlertDescription" :String
, "AlertName" :String
, "AlertSensitivityThreshold" :Integer
, "AnomalyDetectorArn" :String
} }
YAML
Type: AWS::LookoutMetrics::Alert Properties: Action:
Action
AlertDescription:String
AlertName:String
AlertSensitivityThreshold:Integer
AnomalyDetectorArn:String
Properties
Action
-
Action that will be triggered when there is an alert.
Required: Yes
Type: Action
Update requires: Replacement
AlertDescription
-
A description of the alert.
Required: No
Type: String
Pattern:
.*\S.*
Maximum:
256
Update requires: Replacement
AlertName
-
The name of the alert.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9\-_]*
Minimum:
1
Maximum:
63
Update requires: Replacement
AlertSensitivityThreshold
-
An integer from 0 to 100 specifying the alert sensitivity threshold.
Required: Yes
Type: Integer
Minimum:
0
Maximum:
100
Update requires: Replacement
AnomalyDetectorArn
-
The ARN of the detector to which the alert is attached.
Required: Yes
Type: String
Pattern:
arn:([a-z\d-]+):.*:.*:.*:.+
Maximum:
256
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 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 alert. For example,
arn:aws:lookoutmetrics:us-east-2:123456789012:Alert:my-alert