MDAA TS Docs
    Preparing search index...

    Interface DashboardWidgetProps

    Properties for a dashboard widget.

    Use cases: Text dashboard headers; Metric time-series display; Log insights query results

    AWS: CloudWatch dashboard widget configuration

    Validation: type is required; text widgets require markdown; metric widgets require metrics; log insights require logGroupNames and queryString

    interface DashboardWidgetProps {
        height?: number;
        logGroupNames?: string[];
        markdown?: string;
        metrics?: DashboardMetricProps[];
        period?: number;
        queryString?: string;
        title?: string;
        type: "metric" | "text" | "log_insights";
        width?: number;
    }
    Index

    Properties

    height? logGroupNames? markdown? metrics? period? queryString? title? type width?

    Properties

    height?: number

    Height of the widget

    6
    logGroupNames?: string[]

    Log group names for log insights widgets. Use SSM references with {{org}}, {{domain}} placeholders which are resolved by config parser.

    - No log groups (required for log insights widgets)
    markdown?: string

    Markdown content for text widgets

    - No markdown (required for text widgets)
    metrics?: DashboardMetricProps[]

    Metrics to display (for metric widgets)

    - No metrics (required for metric widgets)
    period?: number

    Period for metric widgets in seconds

    300
    queryString?: string

    Query string for log insights widgets

    - No query string (required for log insights widgets)
    title?: string

    The title of the widget

    - No title
    type: "metric" | "text" | "log_insights"

    The type of widget

    width?: number

    Width of the widget (1-24)

    6

    Settings

    Member Visibility

    On This Page

    Properties