Class CfnAlert
The AWS::LookoutMetrics::Alert
type creates an alert for an anomaly detector.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.LookoutMetrics
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAlert : CfnResource, IInspectable
Syntax (vb)
Public Class CfnAlert
Inherits CfnResource
Implements IInspectable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutmetrics-alert.html
CloudformationResource: AWS::LookoutMetrics::Alert
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.LookoutMetrics;
var cfnAlert = new CfnAlert(this, "MyCfnAlert", new CfnAlertProps {
Action = new ActionProperty {
LambdaConfiguration = new LambdaConfigurationProperty {
LambdaArn = "lambdaArn",
RoleArn = "roleArn"
},
SnsConfiguration = new SNSConfigurationProperty {
RoleArn = "roleArn",
SnsTopicArn = "snsTopicArn"
}
},
AlertSensitivityThreshold = 123,
AnomalyDetectorArn = "anomalyDetectorArn",
// the properties below are optional
AlertDescription = "alertDescription",
AlertName = "alertName"
});
Synopsis
Constructors
CfnAlert(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAlert(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnAlert(Construct, String, ICfnAlertProps) |
Properties
Action | Action that will be triggered when there is an alert. |
AlertDescription | A description of the alert. |
AlertName | The name of the alert. |
AlertSensitivityThreshold | An integer from 0 to 100 specifying the alert sensitivity threshold. |
AnomalyDetectorArn | The ARN of the detector to which the alert is attached. |
AttrArn | The Amazon Resource Name (ARN) of the alert. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAlert(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAlert(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAlert(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAlert(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnAlert(Construct, String, ICfnAlertProps)
public CfnAlert(Construct scope, string id, ICfnAlertProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnAlertProps
Resource properties.
Properties
Action
Action that will be triggered when there is an alert.
public virtual object Action { get; set; }
Property Value
System.Object
AlertDescription
A description of the alert.
public virtual string AlertDescription { get; set; }
Property Value
System.String
AlertName
The name of the alert.
public virtual string AlertName { get; set; }
Property Value
System.String
AlertSensitivityThreshold
An integer from 0 to 100 specifying the alert sensitivity threshold.
public virtual double AlertSensitivityThreshold { get; set; }
Property Value
System.Double
AnomalyDetectorArn
The ARN of the detector to which the alert is attached.
public virtual string AnomalyDetectorArn { get; set; }
Property Value
System.String
AttrArn
The Amazon Resource Name (ARN) of the alert.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:lookoutmetrics:us-east-2:123456789012:Alert:my-alert
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>