Package software.amazon.awscdk.services.cloudwatch

Enum VariableInputType

java.lang.Object

java.lang.Enum<VariableInputType>

software.amazon.awscdk.services.cloudwatch.VariableInputType

All Implemented Interfaces:

Serializable, Comparable<VariableInputType>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:54.823Z")
@Stability(Stable)
public enum VariableInputType
extends Enum<VariableInputType>

Example:

 import software.amazon.awscdk.services.cloudwatch.*;
 Dashboard dashboard = Dashboard.Builder.create(this, "Dash")
         .defaultInterval(Duration.days(7))
         .variables(List.of(DashboardVariable.Builder.create()
                 .id("functionName")
                 .type(VariableType.PATTERN)
                 .label("Function")
                 .inputType(VariableInputType.RADIO)
                 .value("originalFuncNameInDashboard")
                 // equivalent to cw.Values.fromSearch('{AWS/Lambda,FunctionName} MetricName=\"Duration\"', 'FunctionName')
                 .values(Values.fromSearchComponents(SearchComponents.builder()
                         .namespace("AWS/Lambda")
                         .dimensions(List.of("FunctionName"))
                         .metricName("Duration")
                         .populateFrom("FunctionName")
                         .build()))
                 .defaultValue(DefaultValue.FIRST)
                 .visible(true)
                 .build()))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INPUT	Freeform text input box.
RADIO	A dropdown of pre-defined values, or values filled in from a metric search query.
SELECT	A set of pre-defined radio buttons, which can also be defined from a metric search query.

Method Summary

Modifier and Type	Method	Description
static VariableInputType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VariableInputType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INPUT

@Stability(Stable)
public static final VariableInputType INPUT

Freeform text input box.

RADIO

@Stability(Stable)
public static final VariableInputType RADIO

A dropdown of pre-defined values, or values filled in from a metric search query.

SELECT

@Stability(Stable)
public static final VariableInputType SELECT

A set of pre-defined radio buttons, which can also be defined from a metric search query.

Method Details

values

public static VariableInputType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VariableInputType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null