software.amazon.awscdk.services.cloudwatch

Class TextWidget

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudwatch.ConcreteWidget

software.amazon.awscdk.services.cloudwatch.TextWidget

All Implemented Interfaces:

IWidget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.312Z")
 @Stability(value=Stable)
public class TextWidget
extends ConcreteWidget

A dashboard widget that displays MarkDown.

Example:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextWidget.Builder A fluent builder for TextWidget.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.IWidget

IWidget.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextWidget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TextWidget(software.amazon.jsii.JsiiObjectRef objRef)
	TextWidget(TextWidgetProps props)

Method Summary

Modifier and Type	Method and Description
void	position(Number x, Number y) Place the widget at a given position.
List<Object>	toJson() Return the widget JSON for use in the dashboard.

Methods inherited from class software.amazon.awscdk.services.cloudwatch.ConcreteWidget

copyMetricWarnings, getHeight, getWarnings, getWidth, getX, getY, setX, setY

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

TextWidget

protected TextWidget(software.amazon.jsii.JsiiObjectRef objRef)

TextWidget

protected TextWidget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

TextWidget

@Stability(value=Stable)
public TextWidget(@NotNull
                                           TextWidgetProps props)

Parameters:

props - This parameter is required.

Method Detail

position

@Stability(value=Stable)
public void position(@NotNull
                                              Number x,
                                              @NotNull
                                              Number y)

Place the widget at a given position.

Specified by:

position in interface IWidget

Overrides:

position in class ConcreteWidget

Parameters:

x - This parameter is required.

y - This parameter is required.

toJson

@Stability(value=Stable)
 @NotNull
public List<Object> toJson()

Return the widget JSON for use in the dashboard.

Specified by:

toJson in interface IWidget

Specified by:

toJson in class ConcreteWidget