Package software.amazon.awscdk.services.cloudwatch

Interface SearchComponents

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SearchComponents.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:32.497Z")
@Stability(Stable)
public interface SearchComponents
extends software.amazon.jsii.JsiiSerializable

Search components for use with

invalid reference

Values.fromSearchComponents

.

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

Modifier and Type	Interface	Description
static final class	SearchComponents.Builder	A builder for SearchComponents
static final class	SearchComponents.Jsii$Proxy	An implementation for SearchComponents

Method Summary

Modifier and Type	Method	Description
static SearchComponents.Builder	builder()
List<String>	getDimensions()	The list of dimensions to be used in the search expression.
String	getMetricName()	The metric name to be used in the search expression.
String	getNamespace()	The namespace to be used in the search expression.
String	getPopulateFrom()	The dimension name, that the search expression retrieves, whose values will be used to populate the values to choose from.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDimensions

@Stability(Stable)
@NotNull
List<String> getDimensions()

The list of dimensions to be used in the search expression.

getMetricName

@Stability(Stable)
@NotNull
String getMetricName()

The metric name to be used in the search expression.

getNamespace

@Stability(Stable)
@NotNull
String getNamespace()

The namespace to be used in the search expression.

getPopulateFrom

@Stability(Stable)
@NotNull
String getPopulateFrom()

The dimension name, that the search expression retrieves, whose values will be used to populate the values to choose from.

builder

@Stability(Stable)
static SearchComponents.Builder builder()

Returns:

a SearchComponents.Builder of SearchComponents