MDAA TS Docs
    Preparing search index...

    Interface MdaaAlarmProps

    Properties for MdaaAlarm construct

    interface MdaaAlarmProps {
        actionsEnabled?: boolean;
        alarmActions?: string[];
        alarmDescription?: string;
        alarmName: string;
        comparisonOperator: string;
        createOutputs?: boolean;
        createParams?: boolean;
        datapointsToAlarm?: number;
        dimensions?: { [key: string]: string };
        evaluationPeriods: number;
        functionName?: string;
        insufficientDataActions?: string[];
        metricName?: string;
        metrics?: MetricDataQueryProps[];
        namespace?: string;
        naming: IMdaaResourceNaming;
        okActions?: string[];
        period?: number;
        statistic?: string;
        threshold: number;
        treatMissingData?: string;
        unit?: string;
    }

    Hierarchy

    • MdaaConstructProps
      • MdaaAlarmProps
    Index

    Properties

    actionsEnabled? alarmActions? alarmDescription? alarmName comparisonOperator createOutputs? createParams? datapointsToAlarm? dimensions? evaluationPeriods functionName? insufficientDataActions? metricName? metrics? namespace? naming okActions? period? statistic? threshold treatMissingData? unit?

    Properties

    actionsEnabled?: boolean

    Whether actions should be executed during alarm state changes

    true
    alarmActions?: string[]

    SNS topic ARNs to notify when the alarm goes to ALARM state

    - No alarm actions
    alarmDescription?: string

    The description of the alarm

    - No description
    alarmName: string

    The name of the alarm

    comparisonOperator: string

    The comparison operator to use

    createOutputs?: boolean

    Flag controlling CloudFormation output and stack export creation for construct resources

    createParams?: boolean

    Flag controlling SSM parameter creation for construct resource references enabling

    datapointsToAlarm?: number

    The number of datapoints that must be breaching to trigger the alarm

    - Same as evaluationPeriods
    dimensions?: { [key: string]: string }

    The dimensions for the metric

    - No dimensions
    evaluationPeriods: number

    The number of periods over which data is compared to the threshold

    functionName?: string

    The Lambda function name (for SSM parameter organization) When provided, alarm metadata will be exported to SSM under the function's namespace

    - Alarm metadata exported without function name in path
    insufficientDataActions?: string[]

    SNS topic ARNs to notify when the alarm goes to INSUFFICIENT_DATA state

    - No insufficient data actions
    metricName?: string

    The metric name (for single metric alarms)

    - No metric name (use metrics array for metric math)
    metrics?: MetricDataQueryProps[]

    The metrics for metric math alarms

    - No metrics (use single metric properties instead)
    namespace?: string

    The metric namespace (for single metric alarms)

    - No namespace (use metrics array for metric math)
    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    okActions?: string[]

    SNS topic ARNs to notify when the alarm goes to OK state

    - No OK actions
    period?: number

    The period for the metric in seconds

    - No period (use metrics array for metric math)
    statistic?: string

    The statistic to apply to the metric

    - No statistic (use metrics array for metric math)
    threshold: number

    The threshold value to compare against

    treatMissingData?: string

    How to treat missing data

    'notBreaching'
    unit?: string

    The unit of the metric

    - No unit

    Settings

    Member Visibility

    On This Page

    Properties