software.amazon.awscdk.services.lookoutmetrics

Class CfnAlert

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.lookoutmetrics.CfnAlert

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:48.775Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnAlert(Construct scope,
                java.lang.String id,
                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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the alert.

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAction

public java.lang.Object getAction()

Action that will be triggered when there is an alert.

setAction

public void setAction(CfnAlert.ActionProperty value)

Action that will be triggered when there is an alert.

setAction

public void setAction(IResolvable value)

Action that will be triggered when there is an alert.

getAlertSensitivityThreshold

public java.lang.Number getAlertSensitivityThreshold()

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

setAlertSensitivityThreshold

public void setAlertSensitivityThreshold(java.lang.Number value)

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

getAnomalyDetectorArn

public java.lang.String getAnomalyDetectorArn()

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

setAnomalyDetectorArn

public void setAnomalyDetectorArn(java.lang.String value)

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

getAlertDescription

public java.lang.String getAlertDescription()

A description of the alert.

setAlertDescription

public void setAlertDescription(java.lang.String value)

A description of the alert.

getAlertName

public java.lang.String getAlertName()

The name of the alert.

setAlertName

public void setAlertName(java.lang.String value)

The name of the alert.