Class AlarmBase
The base class for Alarm and CompositeAlarm resources.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public abstract class AlarmBase : Resource, IAlarm, IAlarmRule, IResource
Syntax (vb)
Public MustInherit Class AlarmBase
Inherits Resource
Implements IAlarm, IAlarmRule, IResource
Synopsis
Constructors
AlarmBase(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
AlarmBase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
AlarmBase(Construct, String, IResourceProps) |
Properties
AlarmActionArns | |
AlarmArn | Alarm ARN (i.e. arn:aws:cloudwatch:<region>:<account-id>:alarm:Foo). |
AlarmName | Name of the alarm. |
InsufficientDataActionArns | |
OkActionArns |
Methods
AddAlarmAction(IAlarmAction[]) | Trigger this action if the alarm fires. |
AddInsufficientDataAction(IAlarmAction[]) | Trigger this action if there is insufficient data to evaluate the alarm. |
AddOkAction(IAlarmAction[]) | Trigger this action if the alarm returns from breaching state into ok state. |
RenderAlarmRule() | AlarmRule indicating ALARM state for Alarm. |
Constructors
AlarmBase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected AlarmBase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
AlarmBase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected AlarmBase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
AlarmBase(Construct, String, IResourceProps)
protected AlarmBase(Construct scope, string id, IResourceProps props = null)
Parameters
- scope Constructs.Construct
- id System.String
- props IResourceProps
Properties
AlarmActionArns
protected virtual string[] AlarmActionArns { get; set; }
Property Value
System.String[]
AlarmArn
Alarm ARN (i.e. arn:aws:cloudwatch:<region>:<account-id>:alarm:Foo).
public abstract string AlarmArn { get; }
Property Value
System.String
Remarks
Attribute: true
AlarmName
Name of the alarm.
public abstract string AlarmName { get; }
Property Value
System.String
InsufficientDataActionArns
protected virtual string[] InsufficientDataActionArns { get; set; }
Property Value
System.String[]
OkActionArns
protected virtual string[] OkActionArns { get; set; }
Property Value
System.String[]
Methods
AddAlarmAction(IAlarmAction[])
Trigger this action if the alarm fires.
public virtual void AddAlarmAction(params IAlarmAction[] actions)
Parameters
- actions IAlarmAction[]
Remarks
Typically SnsAction or AutoScalingAction.
AddInsufficientDataAction(IAlarmAction[])
Trigger this action if there is insufficient data to evaluate the alarm.
public virtual void AddInsufficientDataAction(params IAlarmAction[] actions)
Parameters
- actions IAlarmAction[]
Remarks
Typically SnsAction or AutoScalingAction.
AddOkAction(IAlarmAction[])
Trigger this action if the alarm returns from breaching state into ok state.
public virtual void AddOkAction(params IAlarmAction[] actions)
Parameters
- actions IAlarmAction[]
Remarks
Typically SnsAction or AutoScalingAction.
RenderAlarmRule()
AlarmRule indicating ALARM state for Alarm.
public virtual string RenderAlarmRule()
Returns
System.String