Package software.amazon.awscdk.services.cloudwatch

Class SingleValueWidgetProps.Jsii$Proxy

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

  • 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(SingleValueWidgetProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the SingleValueWidgetProps.Builder.

  • Method Details

    • getMetrics

      public final List<IMetric> getMetrics()
      Description copied from interface: SingleValueWidgetProps
      Metrics to display.
      Specified by:
      getMetrics in interface SingleValueWidgetProps

    • getEnd

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

    • getFullPrecision

      public final Boolean getFullPrecision()
      Description copied from interface: SingleValueWidgetProps
      Whether to show as many digits as can fit, before rounding.

      Default: false

      Specified by:
      getFullPrecision in interface SingleValueWidgetProps

    • getPeriod

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

    • getSetPeriodToTimeRange

      public final Boolean getSetPeriodToTimeRange()
      Description copied from interface: SingleValueWidgetProps
      Whether to show the value from the entire time range.

      Default: false

      Specified by:
      getSetPeriodToTimeRange in interface SingleValueWidgetProps

    • getSparkline

      public final Boolean getSparkline()
      Description copied from interface: SingleValueWidgetProps
      Whether to show a graph below the value illustrating the value for the whole time range.

      Cannot be used in combination with setPeriodToTimeRange

      Default: false

      Specified by:
      getSparkline in interface SingleValueWidgetProps

    • getStart

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

    • 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