@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:51.270Z") @Stability(value=Stable) public interface CustomWidgetProps extends software.amazon.jsii.JsiiSerializable
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());
| Modifier and Type | Interface and Description |
|---|---|
static class |
CustomWidgetProps.Builder
A builder for
CustomWidgetProps |
static class |
CustomWidgetProps.Jsii$Proxy
An implementation for
CustomWidgetProps |
| Modifier and Type | Method and Description |
|---|---|
static CustomWidgetProps.Builder |
builder() |
String |
getFunctionArn()
The Arn of the AWS Lambda function that returns HTML or JSON that will be displayed in the widget.
|
default Number |
getHeight()
Height of the widget.
|
default Object |
getParams()
Parameters passed to the lambda function.
|
String |
getTitle()
The title of the widget.
|
default Boolean |
getUpdateOnRefresh()
Update the widget on refresh.
|
default Boolean |
getUpdateOnResize()
Update the widget on resize.
|
default Boolean |
getUpdateOnTimeRangeChange()
Update the widget on time range change.
|
default Number |
getWidth()
Width of the widget, in a grid of 24 units wide.
|
@Stability(value=Stable) @NotNull String getFunctionArn()
@Stability(value=Stable) @NotNull String getTitle()
@Stability(value=Stable) @Nullable default Number getHeight()
Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.
@Stability(value=Stable) @Nullable default Object getParams()
Default: - no parameters are passed to the lambda function
@Stability(value=Stable) @Nullable default Boolean getUpdateOnRefresh()
Default: true
@Stability(value=Stable) @Nullable default Boolean getUpdateOnResize()
Default: true
@Stability(value=Stable) @Nullable default Boolean getUpdateOnTimeRangeChange()
Default: true
@Stability(value=Stable) @Nullable default Number getWidth()
Default: 6
@Stability(value=Stable) static CustomWidgetProps.Builder builder()
CustomWidgetProps.Builder of CustomWidgetPropsCopyright © 2023. All rights reserved.