TextWidget

class aws_cdk.aws_cloudwatch.TextWidget(*, markdown, height=None, width=None)

Bases: aws_cdk.aws_cloudwatch.ConcreteWidget

A dashboard widget that displays MarkDown.

ExampleMetadata

infused

Example:

# dashboard: cloudwatch.Dashboard


dashboard.add_widgets(cloudwatch.TextWidget(
    markdown="# Key Performance Indicators"
))
Parameters

  • markdown (str) – The text to display, in MarkDown format.

  • height (Union[int, float, None]) – Height of the widget. Default: 2

  • width (Union[int, float, None]) – Width of the widget, in a grid of 24 units wide. Default: 6

Methods

position(x, y)

Place the widget at a given position.

Parameters

  • x (Union[int, float]) –

  • y (Union[int, float]) –

Return type

None

to_json()

Return the widget JSON for use in the dashboard.

Return type

List[Any]

Attributes

height

The amount of vertical grid units the widget will take up.

Return type

Union[int, float]

warnings

Any warnings that are produced as a result of putting together this widget.

Return type

Optional[List[str]]

width

The amount of horizontal grid units the widget will take up.

Return type

Union[int, float]