software.amazon.awscdk.services.lookoutmetrics

Class CfnAlert

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lookoutmetrics.CfnAlert

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.731Z")
 @Stability(value=Stable)
public class CfnAlert
extends CfnResource
implements IInspectable

A CloudFormation `AWS::LookoutMetrics::Alert`.

The AWS::LookoutMetrics::Alert type creates an alert for an anomaly detector.

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.*;
 CfnAlert cfnAlert = CfnAlert.Builder.create(this, "MyCfnAlert")
         .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	Class and Description
static interface	CfnAlert.ActionProperty A configuration that specifies the action to perform when anomalies are detected.
static class	CfnAlert.Builder A fluent builder for CfnAlert.
static interface	CfnAlert.LambdaConfigurationProperty Contains information about a Lambda configuration.
static interface	CfnAlert.SNSConfigurationProperty Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAlert(software.constructs.Construct scope, String id, CfnAlertProps props) Create a new `AWS::LookoutMetrics::Alert`.
protected	CfnAlert(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAlert(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAction() Action that will be triggered when there is an alert.
String	getAlertDescription() A description of the alert.
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.
String	getAttrArn() The Amazon Resource Name (ARN) of the alert.
protected Map<String,Object>	getCfnProperties()
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAction(CfnAlert.ActionProperty value) Action that will be triggered when there is an alert.
void	setAction(IResolvable value) Action that will be triggered when there is an alert.
void	setAlertDescription(String value) A description of the alert.
void	setAlertName(String value) The name of the alert.
void	setAlertSensitivityThreshold(Number value) An integer from 0 to 100 specifying the alert sensitivity threshold.
void	setAnomalyDetectorArn(String value) The ARN of the detector to which the alert is attached.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAlert

protected CfnAlert(software.amazon.jsii.JsiiObjectRef objRef)

CfnAlert

protected CfnAlert(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAlert

@Stability(value=Stable)
public CfnAlert(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnAlertProps props)

Create a new `AWS::LookoutMetrics::Alert`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the alert.

For example, arn:aws:lookoutmetrics:us-east-2:123456789012:Alert:my-alert

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAction

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

Action that will be triggered when there is an alert.

setAction

@Stability(value=Stable)
public void setAction(@NotNull
                                               CfnAlert.ActionProperty value)

Action that will be triggered when there is an alert.

setAction

@Stability(value=Stable)
public void setAction(@NotNull
                                               IResolvable value)

Action that will be triggered when there is an alert.

getAlertSensitivityThreshold

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

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

setAlertSensitivityThreshold

@Stability(value=Stable)
public void setAlertSensitivityThreshold(@NotNull
                                                                  Number value)

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

getAnomalyDetectorArn

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

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

setAnomalyDetectorArn

@Stability(value=Stable)
public void setAnomalyDetectorArn(@NotNull
                                                           String value)

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

getAlertDescription

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

A description of the alert.

setAlertDescription

@Stability(value=Stable)
public void setAlertDescription(@Nullable
                                                         String value)

A description of the alert.

getAlertName

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

The name of the alert.

setAlertName

@Stability(value=Stable)
public void setAlertName(@Nullable
                                                  String value)

The name of the alert.