MDAA TS Docs
    Preparing search index...

    Guardrail intervention alarms notifying an existing SNS topic.

    Use cases: routing guardrail intervention alarms to a central security or incident topic

    AWS: CloudWatch Metrics Insights alarms publishing to an existing SNS topic

    Validation: notificationTopicArn required; createNotificationTopic and notificationEmails not allowed

    interface GuardrailAlarmsExistingTopicProps {
        datapointsToAlarm?: number;
        evaluationPeriods?: number;
        notificationTopicArn: string;
        periodSeconds?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    datapointsToAlarm?: number

    Number of breaching periods within evaluationPeriods required to alarm (an "M of N" alarm).

    Use cases: reducing false positives on low-traffic guardrails

    AWS: CloudWatch alarm datapointsToAlarm

    Validation: Optional; Number; between 1 and evaluationPeriods

    evaluationPeriods
    

    integer

    1

    evaluationPeriods?: number

    Number of periods over which interventions are compared to the threshold.

    Use cases: requiring sustained breaches before alarming

    AWS: CloudWatch alarm evaluation periods

    Validation: Optional; Number; periodSeconds x evaluationPeriods <= 10800

    1
    

    integer

    1

    notificationTopicArn: string

    ARN of an existing SNS topic to notify on alarm, e.g. a central security notification topic. Mutually exclusive with createNotificationTopic.

    MDAA cannot verify or modify a topic it did not create: the topic should be encrypted with a customer-managed KMS key, must allow the cloudwatch.amazonaws.com service principal to sns:Publish (and to use that key), and needs at least one subscriber. MDAA emits a synth-time warning restating this.

    Use cases: routing alarms to an existing security or incident topic

    AWS: SNS topic ARN used as the CloudWatch alarm action

    Validation: Required; String; valid SNS topic ARN; mutually exclusive with createNotificationTopic

    periodSeconds?: number

    Alarm period in seconds. Each period's interventions are compared to the threshold. Must be a multiple of 60, and periodSeconds x evaluationPeriods must not exceed 10800 (3 hours): CloudWatch evaluates Metrics Insights alarms over the most recent 3 hours only.

    Use cases: tuning alarm sensitivity vs. noise

    AWS: CloudWatch alarm period

    Validation: Optional; Number; multiple of 60; periodSeconds x evaluationPeriods <= 10800

    300
    

    integer

    60

    60