Package software.amazon.awscdk.services.cloudwatch

Interface CustomWidgetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomWidgetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:11.815Z")
@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

Nested Classes

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

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFunctionArn

@Stability(Stable)
@NotNull
String getFunctionArn()

The Arn of the AWS Lambda function that returns HTML or JSON that will be displayed in the widget.

getTitle

@Stability(Stable)
@NotNull
String getTitle()

The title of the widget.

getHeight

@Stability(Stable)
@Nullable
default Number 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

@Stability(Stable)
@Nullable
default Object getParams()

Parameters passed to the lambda function.

Default: - no parameters are passed to the lambda function

getUpdateOnRefresh

@Stability(Stable)
@Nullable
default Boolean getUpdateOnRefresh()

Update the widget on refresh.

Default: true

getUpdateOnResize

@Stability(Stable)
@Nullable
default Boolean getUpdateOnResize()

Update the widget on resize.

Default: true

getUpdateOnTimeRangeChange

@Stability(Stable)
@Nullable
default Boolean getUpdateOnTimeRangeChange()

Update the widget on time range change.

Default: true

getWidth

@Stability(Stable)
@Nullable
default Number getWidth()

Width of the widget, in a grid of 24 units wide.

Default: 6

builder

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

Returns:

a CustomWidgetProps.Builder of CustomWidgetProps