Class AlarmBase

The base class for Alarm and CompositeAlarm resources.

Inheritance

object

Resource

AlarmBase

Alarm

CompositeAlarm

Implements

IAlarm

IAlarmRule

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public abstract class AlarmBase : Resource, IAlarm, IAlarmRule, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public MustInherit Class AlarmBase Inherits Resource Implements IAlarm, IAlarmRule, IResource, IConstruct, IDependable, IEnvironmentAware

Synopsis

Constructors

AlarmBase(Construct, string, IResourceProps?)

The base class for Alarm and CompositeAlarm resources.

Properties

AlarmActionArns	The base class for Alarm and CompositeAlarm resources.
AlarmArn	Alarm ARN (i.e. arn:aws:cloudwatch:<region>:<account-id>:alarm:Foo).
AlarmName	Name of the alarm.
InsufficientDataActionArns	The base class for Alarm and CompositeAlarm resources.
OkActionArns	The base class for Alarm and CompositeAlarm resources.

Methods

AddAlarmAction(params IAlarmAction[])	Trigger this action if the alarm fires.
AddInsufficientDataAction(params IAlarmAction[])	Trigger this action if there is insufficient data to evaluate the alarm.
AddOkAction(params IAlarmAction[])	Trigger this action if the alarm returns from breaching state into ok state.
RenderAlarmRule()	AlarmRule indicating ALARM state for Alarm.

Constructors

AlarmBase(Construct, string, IResourceProps?)

The base class for Alarm and CompositeAlarm resources.

protected AlarmBase(Construct scope, string id, IResourceProps? props = null)

Parameters

scope Construct

id string

props IResourceProps

Properties

AlarmActionArns

The base class for Alarm and CompositeAlarm resources.

protected virtual string[]? AlarmActionArns { get; set; }

Property Value

string[]

AlarmArn

Alarm ARN (i.e. arn:aws:cloudwatch:<region>:<account-id>:alarm:Foo).

public abstract string AlarmArn { get; }

Property Value

string

Remarks

Attribute: true

AlarmName

Name of the alarm.

public abstract string AlarmName { get; }

Property Value

string

InsufficientDataActionArns

The base class for Alarm and CompositeAlarm resources.

protected virtual string[]? InsufficientDataActionArns { get; set; }

Property Value

string[]

OkActionArns

The base class for Alarm and CompositeAlarm resources.

protected virtual string[]? OkActionArns { get; set; }

Property Value

string[]

Methods

AddAlarmAction(params IAlarmAction[])

Trigger this action if the alarm fires.

public virtual void AddAlarmAction(params IAlarmAction[] actions)

Parameters

actions IAlarmAction[]

Remarks

Typically SnsAction or AutoScalingAction.

AddInsufficientDataAction(params 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(params 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

string

Implements

IAlarm

IAlarmRule

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware