Package software.amazon.awscdk.services.cloudwatch

Class GraphWidgetProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cloudwatch.GraphWidgetProps.Jsii$Proxy
All Implemented Interfaces:
GraphWidgetProps, MetricWidgetProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
GraphWidgetProps
@Stability(Stable) @Internal public static final class GraphWidgetProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements GraphWidgetProps
An implementation for GraphWidgetProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(GraphWidgetProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the GraphWidgetProps.Builder.

  • Method Details

    • getDisplayLabelsOnChart

      public final Boolean getDisplayLabelsOnChart()
      Description copied from interface: GraphWidgetProps
      Whether the graph should show labels on the chart.

      Currently only applicable for Pie charts.

      Default: false

      Specified by:
      getDisplayLabelsOnChart in interface GraphWidgetProps

    • getEnd

      public final String getEnd()
      Description copied from interface: GraphWidgetProps
      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.

      Default: When the dashboard loads, the end date will be the current time.

      Specified by:
      getEnd in interface GraphWidgetProps

    • getLeft

      public final List<IMetric> getLeft()
      Description copied from interface: GraphWidgetProps
      Metrics to display on left Y axis.

      Default: - No metrics

      Specified by:
      getLeft in interface GraphWidgetProps

    • getLeftAnnotations

      public final List<HorizontalAnnotation> getLeftAnnotations()
      Description copied from interface: GraphWidgetProps
      Annotations for the left Y axis.

      Default: - No annotations

      Specified by:
      getLeftAnnotations in interface GraphWidgetProps

    • getLeftYAxis

      public final YAxisProps getLeftYAxis()
      Description copied from interface: GraphWidgetProps
      Left Y axis.

      Default: - None

      Specified by:
      getLeftYAxis in interface GraphWidgetProps

    • getLegendPosition

      public final LegendPosition getLegendPosition()
      Description copied from interface: GraphWidgetProps
      Position of the legend.

      Default: - bottom

      Specified by:
      getLegendPosition in interface GraphWidgetProps

    • getLiveData

      public final Boolean getLiveData()
      Description copied from interface: GraphWidgetProps
      Whether the graph should show live data.

      Default: false

      Specified by:
      getLiveData in interface GraphWidgetProps

    • getPeriod

      public final Duration getPeriod()
      Description copied from interface: GraphWidgetProps
      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.

      Default: cdk.Duration.seconds(300)

      Specified by:
      getPeriod in interface GraphWidgetProps

    • getRight

      public final List<IMetric> getRight()
      Description copied from interface: GraphWidgetProps
      Metrics to display on right Y axis.

      Default: - No metrics

      Specified by:
      getRight in interface GraphWidgetProps

    • getRightAnnotations

      public final List<HorizontalAnnotation> getRightAnnotations()
      Description copied from interface: GraphWidgetProps
      Annotations for the right Y axis.

      Default: - No annotations

      Specified by:
      getRightAnnotations in interface GraphWidgetProps

    • getRightYAxis

      public final YAxisProps getRightYAxis()
      Description copied from interface: GraphWidgetProps
      Right Y axis.

      Default: - None

      Specified by:
      getRightYAxis in interface GraphWidgetProps

    • getSetPeriodToTimeRange

      public final Boolean getSetPeriodToTimeRange()
      Description copied from interface: GraphWidgetProps
      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.

      Default: false

      Specified by:
      getSetPeriodToTimeRange in interface GraphWidgetProps

    • getStacked

      public final Boolean getStacked()
      Description copied from interface: GraphWidgetProps
      Whether the graph should be shown as stacked lines.

      Default: false

      Specified by:
      getStacked in interface GraphWidgetProps

    • getStart

      public final String getStart()
      Description copied from interface: GraphWidgetProps
      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.

      Default: When the dashboard loads, the start time will be the default time range.

      Specified by:
      getStart in interface GraphWidgetProps

    • getStatistic

      public final String getStatistic()
      Description copied from interface: GraphWidgetProps
      The default statistic to be displayed for each metric.

      This default can be overridden within the definition of each individual metric

      Default: - The statistic for each metric is used

      Specified by:
      getStatistic in interface GraphWidgetProps

    • getVerticalAnnotations

      public final List<VerticalAnnotation> getVerticalAnnotations()
      Description copied from interface: GraphWidgetProps
      Annotations for the X axis.

      Default: - No annotations

      Specified by:
      getVerticalAnnotations in interface GraphWidgetProps

    • getView

      public final GraphWidgetView getView()
      Description copied from interface: GraphWidgetProps
      Display this metric.

      Default: TimeSeries

      Specified by:
      getView in interface GraphWidgetProps

    • getAccountId

      public final String getAccountId()
      Description copied from interface: MetricWidgetProps
      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

      Default: - Current account

      Specified by:
      getAccountId in interface MetricWidgetProps

    • getHeight

      public final Number getHeight()
      Description copied from interface: MetricWidgetProps
      Height of the widget.

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

      Specified by:
      getHeight in interface MetricWidgetProps

    • getRegion

      public final String getRegion()
      Description copied from interface: MetricWidgetProps
      The region the metrics of this graph should be taken from.

      Default: - Current region

      Specified by:
      getRegion in interface MetricWidgetProps

    • getTitle

      public final String getTitle()
      Description copied from interface: MetricWidgetProps
      Title for the graph.

      Default: - None

      Specified by:
      getTitle in interface MetricWidgetProps

    • getWidth

      public final Number getWidth()
      Description copied from interface: MetricWidgetProps
      Width of the widget, in a grid of 24 units wide.

      Default: 6

      Specified by:
      getWidth in interface MetricWidgetProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object