Package software.amazon.awscdk.services.lookoutmetrics

Interface CfnAlertProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlertProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:32.303Z")
@Stability(Stable)
public interface CfnAlertProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAlert.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lookoutmetrics.*;
 CfnAlertProps cfnAlertProps = CfnAlertProps.builder()
         .action(ActionProperty.builder()
                 .lambdaConfiguration(LambdaConfigurationProperty.builder()
                         .lambdaArn("lambdaArn")
                         .roleArn("roleArn")
                         .build())
                 .snsConfiguration(SNSConfigurationProperty.builder()
                         .roleArn("roleArn")
                         .snsTopicArn("snsTopicArn")
                         .build())
                 .build())
         .alertSensitivityThreshold(123)
         .anomalyDetectorArn("anomalyDetectorArn")
         // the properties below are optional
         .alertDescription("alertDescription")
         .alertName("alertName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAlertProps.Builder	A builder for CfnAlertProps
static final class	CfnAlertProps.Jsii$Proxy	An implementation for CfnAlertProps

Method Summary

Modifier and Type	Method	Description
static CfnAlertProps.Builder	builder()
Object	getAction()	Action that will be triggered when there is an alert.
default String	getAlertDescription()	A description of the alert.
default String	getAlertName()	The name of the alert.
Number	getAlertSensitivityThreshold()	An integer from 0 to 100 specifying the alert sensitivity threshold.
String	getAnomalyDetectorArn()	The ARN of the detector to which the alert is attached.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
Object getAction()

Action that will be triggered when there is an alert.

See Also:

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

getAlertSensitivityThreshold

@Stability(Stable)
@NotNull
Number getAlertSensitivityThreshold()

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

See Also:

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

getAnomalyDetectorArn

@Stability(Stable)
@NotNull
String getAnomalyDetectorArn()

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

See Also:

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

getAlertDescription

@Stability(Stable)
@Nullable
default String getAlertDescription()

A description of the alert.

See Also:

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

getAlertName

@Stability(Stable)
@Nullable
default String getAlertName()

The name of the alert.

See Also:

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

builder

@Stability(Stable)
static CfnAlertProps.Builder builder()

Returns:

a CfnAlertProps.Builder of CfnAlertProps