Package software.amazon.awscdk.services.cloudwatch

Class DashboardVariable.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static DashboardVariable.Builder create()
      Returns:
      a new instance of DashboardVariable.Builder.

    • id

      @Stability(Stable) public DashboardVariable.Builder id(String id)
      Unique id.

      Parameters:
      id - Unique id. This parameter is required.
      Returns:
      this

    • inputType

      @Stability(Stable) public DashboardVariable.Builder inputType(VariableInputType inputType)
      The way the variable value is selected.

      Parameters:
      inputType - The way the variable value is selected. This parameter is required.
      Returns:
      this

    • type

      @Stability(Stable) public DashboardVariable.Builder type(VariableType type)
      Type of the variable.

      Parameters:
      type - Type of the variable. This parameter is required.
      Returns:
      this

    • value

      @Stability(Stable) public DashboardVariable.Builder value(String value)
      Pattern or property value to replace.

      Parameters:
      value - Pattern or property value to replace. This parameter is required.
      Returns:
      this

    • defaultValue

      @Stability(Stable) public DashboardVariable.Builder defaultValue(DefaultValue defaultValue)
      Optional default value.

      Default: - no default value is set

      Parameters:
      defaultValue - Optional default value. This parameter is required.
      Returns:
      this

    • label

      @Stability(Stable) public DashboardVariable.Builder label(String label)
      Optional label in the toolbar.

      Default: - the variable's value

      Parameters:
      label - Optional label in the toolbar. This parameter is required.
      Returns:
      this

    • values

      @Stability(Stable) public DashboardVariable.Builder values(Values values)
      Optional values (required for
      invalid reference 
      VariableInputType.RADIO
      and
      invalid reference 
      VariableInputType.SELECT
      dashboard variables).

      Default: - no values

      Parameters:
      values - Optional values (required for
      invalid reference 
      VariableInputType.RADIO
      and
      invalid reference 
      VariableInputType.SELECT
      dashboard variables). This parameter is required.
      Returns:
      this

    • visible

      @Stability(Stable) public DashboardVariable.Builder visible(Boolean visible)
      Whether the variable is visible.

      Default: - true

      Parameters:
      visible - Whether the variable is visible. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public DashboardVariable build()
      Specified by:
      build in interface software.amazon.jsii.Builder<DashboardVariable>
      Returns:
      a newly built instance of DashboardVariable.