aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation

interface HorizontalAnnotation

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

Obtainable from Alarm.toAnnotation()

Horizontal annotation to be added to a graph.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const horizontalAnnotation: cloudwatch.HorizontalAnnotation = {
  value: 123,

  // the properties below are optional
  color: 'color',
  fill: cloudwatch.Shading.NONE,
  label: 'label',
  visible: false,
};

Properties

NameTypeDescription
valuenumberThe value of the annotation.
color?stringThe hex color code, prefixed with '#' (e.g. '#00ff00'), to be used for the annotation. The Color class has a set of standard colors that can be used here.
fill?ShadingAdd shading above or below the annotation.
label?stringLabel for the annotation.
visible?booleanWhether the annotation is visible.

value

Type: number

The value of the annotation.


color?

Type: string (optional, default: Automatic color)

The hex color code, prefixed with '#' (e.g. '#00ff00'), to be used for the annotation. The Color class has a set of standard colors that can be used here.


fill?

Type: Shading (optional, default: No shading)

Add shading above or below the annotation.


label?

Type: string (optional, default: No label)

Label for the annotation.


visible?

Type: boolean (optional, default: true)

Whether the annotation is visible.