Package software.amazon.awscdk.services.cloudwatch

Class DashboardProps.Jsii$Proxy

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

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

  • Method Details

    • getDashboardName

      public final String getDashboardName()
      Description copied from interface: DashboardProps
      Name of the dashboard.

      If set, must only contain alphanumerics, dash (-) and underscore (_)

      Default: - automatically generated name

      Specified by:
      getDashboardName in interface DashboardProps

    • getDefaultInterval

      public final Duration getDefaultInterval()
      Description copied from interface: DashboardProps
      Interval duration for metrics. You can specify defaultInterval with the relative time(eg. cdk.Duration.days(7)).

      Both properties defaultInterval and start cannot be set at once.

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

      Specified by:
      getDefaultInterval in interface DashboardProps

    • getEnd

      public final String getEnd()
      Description copied from interface: DashboardProps
      The end of the time range to use for each widget on the dashboard when the dashboard loads.

      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 DashboardProps

    • getPeriodOverride

      public final PeriodOverride getPeriodOverride()
      Description copied from interface: DashboardProps
      Use this field to specify the period for the graphs when the dashboard loads.

      Specifying Auto causes the period of all graphs on the dashboard to automatically adapt to the time range of the dashboard. Specifying Inherit ensures that the period set for each graph is always obeyed.

      Default: Auto

      Specified by:
      getPeriodOverride in interface DashboardProps

    • getStart

      public final String getStart()
      Description copied from interface: DashboardProps
      The start of the time range to use for each widget on 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.

      Both properties defaultInterval and start cannot be set at once.

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

      Specified by:
      getStart in interface DashboardProps

    • getVariables

      public final List<IVariable> getVariables()
      Description copied from interface: DashboardProps
      A list of dashboard variables.

      Default: - No variables

      Specified by:
      getVariables in interface DashboardProps
      See Also:

    • getWidgets

      public final List<List<IWidget>> getWidgets()
      Description copied from interface: DashboardProps
      Initial set of widgets on the dashboard.

      One array represents a row of widgets.

      Default: - No widgets

      Specified by:
      getWidgets in interface DashboardProps

    • $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