Package software.amazon.awscdk.services.cloudwatch

Class CustomWidgetProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CustomWidgetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CustomWidgetProps>

Enclosing interface:

CustomWidgetProps

@Stability(Stable)
public static final class CustomWidgetProps.Builder
extends Object
implements software.amazon.jsii.Builder<CustomWidgetProps>

A builder for CustomWidgetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CustomWidgetProps	build()	Builds the configured instance.
CustomWidgetProps.Builder	functionArn(String functionArn)	Sets the value of CustomWidgetProps.getFunctionArn()
CustomWidgetProps.Builder	height(Number height)	Sets the value of CustomWidgetProps.getHeight()
CustomWidgetProps.Builder	params(Object params)	Sets the value of CustomWidgetProps.getParams()
CustomWidgetProps.Builder	title(String title)	Sets the value of CustomWidgetProps.getTitle()
CustomWidgetProps.Builder	updateOnRefresh(Boolean updateOnRefresh)	Sets the value of CustomWidgetProps.getUpdateOnRefresh()
CustomWidgetProps.Builder	updateOnResize(Boolean updateOnResize)	Sets the value of CustomWidgetProps.getUpdateOnResize()
CustomWidgetProps.Builder	updateOnTimeRangeChange(Boolean updateOnTimeRangeChange)	Sets the value of CustomWidgetProps.getUpdateOnTimeRangeChange()
CustomWidgetProps.Builder	width(Number width)	Sets the value of CustomWidgetProps.getWidth()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

functionArn

@Stability(Stable)
public CustomWidgetProps.Builder functionArn(String functionArn)

Sets the value of CustomWidgetProps.getFunctionArn()

Parameters:

functionArn - The Arn of the AWS Lambda function that returns HTML or JSON that will be displayed in the widget. This parameter is required.

Returns:

this

title

@Stability(Stable)
public CustomWidgetProps.Builder title(String title)

Sets the value of CustomWidgetProps.getTitle()

Parameters:

title - The title of the widget. This parameter is required.

Returns:

this

height

@Stability(Stable)
public CustomWidgetProps.Builder height(Number height)

Sets the value of CustomWidgetProps.getHeight()

Parameters:

height - Height of the widget.

Returns:

this

params

@Stability(Stable)
public CustomWidgetProps.Builder params(Object params)

Sets the value of CustomWidgetProps.getParams()

Parameters:

params - Parameters passed to the lambda function.

Returns:

this

updateOnRefresh

@Stability(Stable)
public CustomWidgetProps.Builder updateOnRefresh(Boolean updateOnRefresh)

Sets the value of CustomWidgetProps.getUpdateOnRefresh()

Parameters:

updateOnRefresh - Update the widget on refresh.

Returns:

this

updateOnResize

@Stability(Stable)
public CustomWidgetProps.Builder updateOnResize(Boolean updateOnResize)

Sets the value of CustomWidgetProps.getUpdateOnResize()

Parameters:

updateOnResize - Update the widget on resize.

Returns:

this

updateOnTimeRangeChange

@Stability(Stable)
public CustomWidgetProps.Builder updateOnTimeRangeChange(Boolean updateOnTimeRangeChange)

Sets the value of CustomWidgetProps.getUpdateOnTimeRangeChange()

Parameters:

updateOnTimeRangeChange - Update the widget on time range change.

Returns:

this

width

@Stability(Stable)
public CustomWidgetProps.Builder width(Number width)

Sets the value of CustomWidgetProps.getWidth()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CustomWidgetProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CustomWidgetProps>

Returns:

a new instance of CustomWidgetProps

Throws:

NullPointerException - if any required attribute was not provided