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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.733Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 Detail

getAction

@Stability(value=Stable)
 @NotNull
Object getAction()

Action that will be triggered when there is an alert.

getAlertSensitivityThreshold

@Stability(value=Stable)
 @NotNull
Number getAlertSensitivityThreshold()

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

getAnomalyDetectorArn

@Stability(value=Stable)
 @NotNull
String getAnomalyDetectorArn()

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

getAlertDescription

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

A description of the alert.

getAlertName

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

The name of the alert.

builder

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

Returns:

a CfnAlertProps.Builder of CfnAlertProps