AWS CDK Reference

Appearance

v2.275.0

VerticalAnnotation Struct ​

Vertical annotation to be added to a graph.

Source
aws-cloudwatch/lib/graph.ts
Type last changed
v2.97.0 · 22 Sep 2023

Example ​

ts
// 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 verticalAnnotation: cloudwatch.VerticalAnnotation = {
  date: 'date',

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

Properties ​

coloroptionalstringcoloroptionalstrcoloroptionalStringColoroptionalstringColoroptional*string#
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.

Default: Automatic color

datestringdatestrdateStringDatestringDate*stringrequired#
The date and time (in ISO 8601 format) in the graph where the vertical annotation line is to appear.
filloptionalVerticalShadingfilloptionalVerticalShadingfilloptionalVerticalShadingFilloptionalVerticalShadingFilloptionalVerticalShading#
Add shading before or after the annotation.

Default: No shading

labeloptionalstringlabeloptionalstrlabeloptionalStringLabeloptionalstringLabeloptional*string#
Label for the annotation.

Default: No label

visibleoptionalbooleanvisibleoptionalboolvisibleoptionalBooleanVisibleoptionalboolVisibleoptional*bool= true#
Whether the annotation is visible.