Package software.amazon.awscdk.services.cloudwatch

Class CfnAlarm.MetricStatProperty.Builder

java.lang.Object
software.amazon.awscdk.services.cloudwatch.CfnAlarm.MetricStatProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAlarm.MetricStatProperty>
Enclosing interface:
CfnAlarm.MetricStatProperty
@Stability(Stable) public static final class CfnAlarm.MetricStatProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnAlarm.MetricStatProperty>
A builder for CfnAlarm.MetricStatProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • metric

      @Stability(Stable) public CfnAlarm.MetricStatProperty.Builder metric(IResolvable metric)
      Sets the value of CfnAlarm.MetricStatProperty.getMetric()
      Parameters:
      metric - The metric to return, including the metric name, namespace, and dimensions. This parameter is required.
      Returns:
      this

    • metric

      @Stability(Stable) public CfnAlarm.MetricStatProperty.Builder metric(CfnAlarm.MetricProperty metric)
      Sets the value of CfnAlarm.MetricStatProperty.getMetric()
      Parameters:
      metric - The metric to return, including the metric name, namespace, and dimensions. This parameter is required.
      Returns:
      this

    • period

      @Stability(Stable) public CfnAlarm.MetricStatProperty.Builder period(Number period)
      Sets the value of CfnAlarm.MetricStatProperty.getPeriod()
      Parameters:
      period - The granularity, in seconds, of the returned data points. This parameter is required. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

      If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

      • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
      • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
      • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
      Returns:
      this

    • stat

      @Stability(Stable) public CfnAlarm.MetricStatProperty.Builder stat(String stat)
      Sets the value of CfnAlarm.MetricStatProperty.getStat()
      Parameters:
      stat - The statistic to return. This parameter is required. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
      Returns:
      this

    • unit

      @Stability(Stable) public CfnAlarm.MetricStatProperty.Builder unit(String unit)
      Sets the value of CfnAlarm.MetricStatProperty.getUnit()
      Parameters:
      unit - The unit to use for the returned data points. Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
      Returns:
      this

    • build

      @Stability(Stable) public CfnAlarm.MetricStatProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnAlarm.MetricStatProperty>
      Returns:
      a new instance of CfnAlarm.MetricStatProperty
      Throws:
      NullPointerException - if any required attribute was not provided