AWS CDK Reference

Appearance

v2.274.0

TableWidget Class ​

A dashboard widget that displays metrics.

Source
aws-cloudwatch/lib/graph.ts
Type last changed
v2.128.0 · 14 Feb 2024

Example ​

ts
declare const dashboard: cloudwatch.Dashboard;

dashboard.addWidgets(new cloudwatch.TableWidget({
  // ...

  layout: cloudwatch.TableLayout.VERTICAL,
}));
python
# dashboard: cloudwatch.Dashboard


dashboard.add_widgets(cloudwatch.TableWidget(
    # ...

    layout=cloudwatch.TableLayout.VERTICAL
))
java
Dashboard dashboard;


dashboard.addWidgets(TableWidget.Builder.create()
        // ...

        .layout(TableLayout.VERTICAL)
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
Dashboard dashboard;


dashboard.AddWidgets(new TableWidget(new TableWidgetProps {
    // ...

    Layout = TableLayout.VERTICAL
}));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var dashboard Dashboard


dashboard.AddWidgets(cloudwatch.NewTableWidget(&TableWidgetProps{
	// ...

	Layout: cloudwatch.TableLayout_VERTICAL,
}))

Initializer ​

ts
new TableWidget(props: TableWidgetProps)
python
TableWidget(props: TableWidgetProps)
java
new TableWidget(TableWidgetProps props)
csharp
new TableWidget(TableWidgetProps props)
go
NewTableWidget(Props TableWidgetProps)

Properties ​

heightnumberheightint | floatheightNumberHeightdoubleHeight*float64required#
The amount of vertical grid units the widget will take up.
warningsmay be undefinedstring[]warningsmay be undefinedtyping.List[str]warningsmay be undefinedList<String>Warningsmay be undefinedstring[]Warningsmay be undefined*[]*string#
Any warnings that are produced as a result of putting together this widget.
warningsV2may be undefined{ [key: string]: string }warnings_v2may be undefinedtyping.Mapping[str, str]warningsV2may be undefinedMap<String, String>WarningsV2may be undefinedIDictionary<string, string>WarningsV2may be undefined*map[string]*string#
Any warnings that are produced as a result of putting together this widget.
widthnumberwidthint | floatwidthNumberWidthdoubleWidth*float64required#
The amount of horizontal grid units the widget will take up.

Methods ​

addMetric(metric: IMetric): voiddef add_metric(self, metric: IMetric) -> Nonepublic void addMetric(IMetric metric)public void AddMetric(IMetric metric)func AddMetric(Metric IMetric)#
Add another metric.
1 parameter

Parameters

  • metricmetricmetricmetricMetric — the metric to add.
position(x: number, y: number): voiddef position(self, x: int | float, y: int | float) -> Nonepublic void position(Number x, Number y)public void Position(double x, double y)func Position(X *float64, Y *float64)#
Place the widget at a given position.
toJson(): any[]def to_json(self, ) -> typing.List[Any]public List<Object> toJson()public object[] ToJson()func ToJson() *[]interface{}#
Return the widget JSON for use in the dashboard.