@guardian/cdk
    Preparing search index...

    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
    Index

    Properties

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

    Properties

    actionsEnabled?: boolean

    Whether the actions for this alarm are enabled

    true
    alarmDescription?: string

    Description for the alarm

    No description
    alarmName?: string

    Name of the alarm

    Automatically generated name
    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.

    evaluationPeriods

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

    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.

    - Not configured.
    lengthOfEvaluationPeriod?: Duration
    noMonitoring?: false
    numberOfEvaluationPeriodsAboveThresholdBeforeAlarm?: number
    okAction?: boolean
    snsTopicName: string
    toleratedErrorPercentage: number

    Settings

    Member Visibility

    On This Page

    Properties