GradientEdge CDK Utils
    Preparing search index...

    Interface GuageWidgetProps

    interface GuageWidgetProps {
        accountId?: string;
        annotations?: HorizontalAnnotation[];
        end?: string;
        height?: number;
        leftYAxis?: YAxisProps;
        legendPosition?: LegendPosition;
        liveData?: boolean;
        metricProps: MetricProps[];
        metrics?: IMetric[];
        period?: Duration;
        positionX: number;
        positionY: number;
        region?: string;
        setPeriodToTimeRange?: boolean;
        start?: string;
        statistic?: string;
        title?: string;
        type: string;
        width?: number;
    }

    Hierarchy

    • GaugeWidgetProps
      • GuageWidgetProps
    Index

    Properties

    accountId? annotations? end? height? leftYAxis? legendPosition? liveData? metricProps metrics? period? positionX positionY region? setPeriodToTimeRange? start? statistic? title? type width?

    Properties

    accountId?: string

    The AWS account ID where the metrics are located.

    This enables cross-account functionality for CloudWatch dashboards. Before using this feature, ensure that proper cross-account sharing is configured between the monitoring account and source account.

    For more information, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html

    - Current account
    annotations?: HorizontalAnnotation[]

    Annotations for the left Y axis

    - No annotations
    end?: string

    The end of the time range to use for each widget independently from those of the dashboard. If you specify a value for end, you must also specify a value for start. Specify an absolute time in the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.

    When the dashboard loads, the end date will be the current time.
    height?: number

    Height of the widget

    - 6 for Alarm and Graph widgets.
      3 for single value widgets where most recent value of a metric is displayed.
    leftYAxis?: YAxisProps

    Left Y axis

    {min:0,max:100}
    legendPosition?: LegendPosition

    Position of the legend

    - bottom
    liveData?: boolean

    Whether the graph should show live data

    false
    metricProps: MetricProps[]
    metrics?: IMetric[]

    Metrics to display on left Y axis

    - No metrics
    period?: Duration

    The default period for all metrics in this widget. The period is the length of time represented by one data point on the graph. This default can be overridden within each metric definition.

    cdk.Duration.seconds(300)
    positionX: number
    positionY: number
    region?: string

    The region the metrics of this graph should be taken from

    - Current region
    setPeriodToTimeRange?: boolean

    Whether to show the value from the entire time range. Only applicable for Bar and Pie charts.

    If false, values will be from the most recent period of your chosen time range; if true, shows the value from the entire time range.

    false
    start?: string

    The start of the time range to use for each widget independently from those of the dashboard. You can specify start without specifying end to specify a relative time range that ends with the current time. In this case, the value of start must begin with -P, and you can use M, H, D, W and M as abbreviations for minutes, hours, days, weeks and months. For example, -PT8H shows the last 8 hours and -P3M shows the last three months. You can also use start along with an end field, to specify an absolute time range. When specifying an absolute time range, use the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.

    When the dashboard loads, the start time will be the default time range.
    statistic?: string

    The default statistic to be displayed for each metric. This default can be overridden within the definition of each individual metric

    - The statistic for each metric is used
    title?: string

    Title for the graph

    - None
    type: string
    width?: number

    Width of the widget, in a grid of 24 units wide

    6

    Settings

    Member Visibility

    On This Page

    Properties