aws-cdk-lib.aws_cloudwatch.TextWidgetProps

interface TextWidgetProps

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

Properties for a Text widget.

Example

declare const dashboard: cloudwatch.Dashboard;

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

Properties

NameTypeDescription
markdownstringThe text to display, in MarkDown format.
background?TextWidgetBackgroundBackground for the widget.
height?numberHeight of the widget.
width?numberWidth of the widget, in a grid of 24 units wide.

markdown

Type: string

The text to display, in MarkDown format.


background?

Type: TextWidgetBackground (optional, default: solid)

Background for the widget.


height?

Type: number (optional, default: 2)

Height of the widget.


width?

Type: number (optional, default: 6)

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