class SingleValueWidget
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.CloudWatch.SingleValueWidget |
Java | software.amazon.awscdk.services.cloudwatch.SingleValueWidget |
Python | aws_cdk.aws_cloudwatch.SingleValueWidget |
TypeScript (source) | @aws-cdk/aws-cloudwatch » SingleValueWidget |
Implements
IWidget
Extends
Concrete
A dashboard widget that displays the most recent value for every metric.
Example
declare const dashboard: cloudwatch.Dashboard;
declare const visitorCount: cloudwatch.Metric;
declare const purchaseCount: cloudwatch.Metric;
dashboard.addWidgets(new cloudwatch.SingleValueWidget({
metrics: [visitorCount, purchaseCount],
}));
Initializer
new SingleValueWidget(props: SingleValueWidgetProps)
Parameters
- props
Single
Value Widget Props
Properties
Name | Type | Description |
---|---|---|
height | number | The amount of vertical grid units the widget will take up. |
width | number | The amount of horizontal grid units the widget will take up. |
warnings? | string[] | Any warnings that are produced as a result of putting together this widget. |
height
Type:
number
The amount of vertical grid units the widget will take up.
width
Type:
number
The amount of horizontal grid units the widget will take up.
warnings?
Type:
string[]
(optional)
Any warnings that are produced as a result of putting together this widget.
Methods
Name | Description |
---|---|
position(x, y) | Place the widget at a given position. |
to | Return the widget JSON for use in the dashboard. |
position(x, y)
public position(x: number, y: number): void
Parameters
- x
number
- y
number
Place the widget at a given position.
Json()
topublic toJson(): any[]
Returns
any[]
Return the widget JSON for use in the dashboard.