Package software.amazon.awscdk.services.cloudwatch

Interface TextWidgetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TextWidgetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:58.542Z")
@Stability(Stable)
public interface TextWidgetProps
extends software.amazon.jsii.JsiiSerializable

Properties for a Text widget.

Example:

 Dashboard dashboard;
 dashboard.addWidgets(TextWidget.Builder.create()
         .markdown("# Key Performance Indicators")
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TextWidgetProps.Builder	builder()
default TextWidgetBackground	getBackground()	Background for the widget.
default Number	getHeight()	Height of the widget.
String	getMarkdown()	The text to display, in MarkDown format.
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

getMarkdown

@Stability(Stable)
@NotNull
String getMarkdown()

The text to display, in MarkDown format.

getBackground

@Stability(Stable)
@Nullable
default TextWidgetBackground getBackground()

Background for the widget.

Default: solid

getHeight

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

Height of the widget.

Default: 2

getWidth

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

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

Default: 6

builder

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

Returns:

a TextWidgetProps.Builder of TextWidgetProps