MDAA TS Docs
    Preparing search index...

    Guardrail intervention alarms notifying a module-created SNS topic.

    Use cases: self-contained alerting without a pre-existing topic

    AWS: CloudWatch Metrics Insights alarms publishing to an MDAA-created CMK-encrypted SNS topic

    Validation: createNotificationTopic: true required; notificationTopicArn not allowed; not allowed with kmsKeyArn

    interface GuardrailAlarmsCreatedTopicProps {
        createNotificationTopic: boolean;
        datapointsToAlarm?: number;
        evaluationPeriods?: number;
        notificationEmails?: string[];
        periodSeconds?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createNotificationTopic: boolean

    Set to true to have MDAA create an SNS topic encrypted with the module KMS key, grant CloudWatch alarms in this module publish access, and export its ARN to SSM. Mutually exclusive with notificationTopicArn. Not supported with kmsKeyArn: MDAA cannot grant CloudWatch use of an imported key, so the topic would never receive a notification.

    Use cases: self-contained alerting without a pre-existing topic

    AWS: MDAA-created CMK-encrypted SNS topic

    Validation: Required; Boolean; must be true; mutually exclusive with notificationTopicArn; not allowed with kmsKeyArn

    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

    notificationEmails?: string[]

    Email addresses subscribed to the module-created notification topic. Each address receives an SNS confirmation request and must confirm before delivery begins. Without a subscriber the created topic discards every notification; MDAA warns at synth in that case.

    Use cases: security team paging, routing alarms to a distribution list

    AWS: SNS email subscriptions on the created topic

    Validation: Optional; String[]; valid email addresses

    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