Interface GuLambdaErrorPercentageMonitoringProps

interface GuLambdaErrorPercentageMonitoringProps {
    actionsEnabled?: boolean;
    alarmDescription?: string;
    alarmName?: string;
    datapointsToAlarm?: number;
    evaluateLowSampleCountPercentile?: string;
    lengthOfEvaluationPeriod?: Duration;
    noMonitoring?: false;
    numberOfEvaluationPeriodsAboveThresholdBeforeAlarm?: number;
    okAction?: boolean;
    snsTopicName: string;
    toleratedErrorPercentage: number;
}

Hierarchy

  • Omit<GuAlarmProps, "metric" | "threshold" | "comparisonOperator" | "evaluationPeriods" | "treatMissingData" | "app">
    • GuLambdaErrorPercentageMonitoringProps

Properties

actionsEnabled? alarmDescription? alarmName? datapointsToAlarm? evaluateLowSampleCountPercentile? lengthOfEvaluationPeriod? noMonitoring? numberOfEvaluationPeriodsAboveThresholdBeforeAlarm? okAction? snsTopicName toleratedErrorPercentage

Properties

Optional Readonly actionsEnabled

actionsEnabled?: boolean

Whether the actions for this alarm are enabled

Default

true

Optional Readonly alarmDescription

alarmDescription?: string

Description for the alarm

Default

No description

Optional Readonly alarmName

alarmName?: string

Name of the alarm

Default

Automatically generated name

Optional Readonly datapointsToAlarm

datapointsToAlarm?: number

The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

Default

evaluationPeriods

See

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation

Optional Readonly evaluateLowSampleCountPercentile

evaluateLowSampleCountPercentile?: string

Specifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant.

Used only for alarms that are based on percentiles.

Default

- Not configured.

Optional lengthOfEvaluationPeriod

lengthOfEvaluationPeriod?: Duration

Optional noMonitoring

noMonitoring?: false

Optional numberOfEvaluationPeriodsAboveThresholdBeforeAlarm

numberOfEvaluationPeriodsAboveThresholdBeforeAlarm?: number

Optional okAction

okAction?: boolean

snsTopicName

snsTopicName: string

toleratedErrorPercentage

toleratedErrorPercentage: number

Settings

Member Visibility

Theme

On This Page

actionsEnabledalarmDescriptionalarmNamedatapointsToAlarmevaluateLowSampleCountPercentilelengthOfEvaluationPeriodnoMonitoringnumberOfEvaluationPeriodsAboveThresholdBeforeAlarmokActionsnsTopicNametoleratedErrorPercentage