MDAA TS Docs
    Preparing search index...

    Interface RestApiAlarmConfig

    CloudWatch alarm configuration for the REST API.

    interface RestApiAlarmConfig {
        error4xxRate?: AlarmThresholdConfig;
        error5xxRate?: AlarmThresholdConfig;
        lambdaConcurrency?: AlarmThresholdConfig;
        latencyP99?: AlarmThresholdConfig;
        snsTopicArn?: string;
        throttle429?: AlarmThresholdConfig;
    }
    Index

    Properties

    error4xxRate? error5xxRate? lambdaConcurrency? latencyP99? snsTopicArn? throttle429?

    Properties

    error4xxRate?: AlarmThresholdConfig

    4XX error rate alarm. Threshold is a percentage (0-100).

    { threshold: 20, period: 300, evaluationPeriods: 3 }
    error5xxRate?: AlarmThresholdConfig

    5XX error rate alarm. Threshold is a percentage (0-100).

    { threshold: 5, period: 300, evaluationPeriods: 3 }
    lambdaConcurrency?: AlarmThresholdConfig

    Lambda concurrent-execution saturation alarm on the REST API handler. Fires when concurrent executions approach the function's ceiling, giving operators warning before requests start being throttled at the Lambda layer. Threshold is an absolute concurrent-execution count and should be set below the account/reserved concurrency limit for the function.

    { threshold: 100, period: 300, evaluationPeriods: 3 }
    latencyP99?: AlarmThresholdConfig

    P99 latency alarm. Threshold is in milliseconds.

    { threshold: 10000, period: 300, evaluationPeriods: 3 }
    snsTopicArn?: string

    SNS topic ARN for alarm notifications. If not provided, a new topic is created.

    throttle429?: AlarmThresholdConfig

    Throttle (HTTP 429) alarm. Fires when the number of throttled requests in a period exceeds the threshold (an absolute count, not a percentage), surfacing either client abuse or a misconfigured caller hammering the API. API Gateway's 4XXError CloudWatch metric is not broken down by status code, so this alarm is backed by a metric filter on the access log that counts responses with status = 429.

    { threshold: 100, period: 300, evaluationPeriods: 1 }

    Settings

    Member Visibility

    On This Page

    Properties