CfnAlertProps

class aws_cdk.aws_lookoutmetrics.CfnAlertProps(*, action, alert_sensitivity_threshold, anomaly_detector_arn, alert_description=None, alert_name=None)

Bases: object

Properties for defining a CfnAlert.

Parameters
  • action (Union[ActionProperty, IResolvable]) – Action that will be triggered when there is an alert.

  • alert_sensitivity_threshold (Union[int, float]) – An integer from 0 to 100 specifying the alert sensitivity threshold.

  • anomaly_detector_arn (str) – The ARN of the detector to which the alert is attached.

  • alert_description (Optional[str]) – A description of the alert.

  • alert_name (Optional[str]) – The name of the alert.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_lookoutmetrics as lookoutmetrics

cfn_alert_props = lookoutmetrics.CfnAlertProps(
    action=lookoutmetrics.CfnAlert.ActionProperty(
        lambda_configuration=lookoutmetrics.CfnAlert.LambdaConfigurationProperty(
            lambda_arn="lambdaArn",
            role_arn="roleArn"
        ),
        sns_configuration=lookoutmetrics.CfnAlert.SNSConfigurationProperty(
            role_arn="roleArn",
            sns_topic_arn="snsTopicArn"
        )
    ),
    alert_sensitivity_threshold=123,
    anomaly_detector_arn="anomalyDetectorArn",

    # the properties below are optional
    alert_description="alertDescription",
    alert_name="alertName"
)

Attributes

action

Action that will be triggered when there is an alert.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-action

Return type

Union[ActionProperty, IResolvable]

alert_description

A description of the alert.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-alertdescription

Return type

Optional[str]

alert_name

The name of the alert.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-alertname

Return type

Optional[str]

alert_sensitivity_threshold

An integer from 0 to 100 specifying the alert sensitivity threshold.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-alertsensitivitythreshold

Return type

Union[int, float]

anomaly_detector_arn

The ARN of the detector to which the alert is attached.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html#cfn-lookoutmetrics-alert-anomalydetectorarn

Return type

str