Interface CustomWidgetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CustomWidgetProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-06T14:43:15.733Z")
@Stability(Stable)
public interface CustomWidgetProps
extends software.amazon.jsii.JsiiSerializable
The properties for a CustomWidget.
Example:
Dashboard dashboard; // Import or create a lambda function IFunction fn = Function.fromFunctionArn(dashboard, "Function", "arn:aws:lambda:us-east-1:123456789012:function:MyFn"); dashboard.addWidgets(CustomWidget.Builder.create() .functionArn(fn.getFunctionArn()) .title("My lambda baked widget") .build());
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCustomWidgetProps
static final class
An implementation forCustomWidgetProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CustomWidgetProps.Builder
builder()
The Arn of the AWS Lambda function that returns HTML or JSON that will be displayed in the widget.default Number
Height of the widget.default Object
Parameters passed to the lambda function.getTitle()
The title of the widget.default Boolean
Update the widget on refresh.default Boolean
Update the widget on resize.default Boolean
Update the widget on time range change.default Number
getWidth()
Width of the widget, in a grid of 24 units wide.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getFunctionArn
The Arn of the AWS Lambda function that returns HTML or JSON that will be displayed in the widget. -
getTitle
The title of the widget. -
getHeight
Height of the widget.Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.
-
getParams
Parameters passed to the lambda function.Default: - no parameters are passed to the lambda function
-
getUpdateOnRefresh
Update the widget on refresh.Default: true
-
getUpdateOnResize
Update the widget on resize.Default: true
-
getUpdateOnTimeRangeChange
Update the widget on time range change.Default: true
-
getWidth
Width of the widget, in a grid of 24 units wide.Default: 6
-
builder
- Returns:
- a
CustomWidgetProps.Builder
ofCustomWidgetProps
-