aws-cdk-lib.aws_cloudwatch.TextWidget

class TextWidget

LanguageType name
.NETAmazon.CDK.AWS.CloudWatch.TextWidget
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#TextWidget
Javasoftware.amazon.awscdk.services.cloudwatch.TextWidget
Pythonaws_cdk.aws_cloudwatch.TextWidget
TypeScript (source)aws-cdk-lib » aws_cloudwatch » TextWidget

Implements IWidget

Extends ConcreteWidget

A dashboard widget that displays MarkDown.

Example

declare const dashboard: cloudwatch.Dashboard;

dashboard.addWidgets(new cloudwatch.TextWidget({
  markdown: '# Key Performance Indicators'
}));

Initializer

new TextWidget(props: TextWidgetProps)

Parameters

  • props TextWidgetProps

Properties

NameTypeDescription
heightnumberThe amount of vertical grid units the widget will take up.
widthnumberThe amount of horizontal grid units the widget will take up.
warnings?string[]Any warnings that are produced as a result of putting together this widget.

height

Type: number

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


width

Type: number

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


warnings?

Type: string[] (optional)

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

Methods

NameDescription
position(x, y)Place the widget at a given position.
toJson()Return the widget JSON for use in the dashboard.

position(x, y)

public position(x: number, y: number): void

Parameters

  • x number
  • y number

Place the widget at a given position.


toJson()

public toJson(): any[]

Returns

  • any[]

Return the widget JSON for use in the dashboard.