VerticalAnnotation

class aws_cdk.aws_cloudwatch.VerticalAnnotation(*, date, color=None, fill=None, label=None, visible=None)

Bases: object

Vertical annotation to be added to a graph.

Parameters:
  • date (str) – The date and time (in ISO 8601 format) in the graph where the vertical annotation line is to appear.

  • color (Optional[str]) – 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

  • fill (Optional[VerticalShading]) – Add shading before or after the annotation. Default: No shading

  • label (Optional[str]) – Label for the annotation. Default: - No label

  • visible (Optional[bool]) – Whether the annotation is visible. Default: true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudwatch as cloudwatch

vertical_annotation = cloudwatch.VerticalAnnotation(
    date="date",

    # the properties below are optional
    color="color",
    fill=cloudwatch.VerticalShading.NONE,
    label="label",
    visible=False
)

Attributes

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.

Default:
  • Automatic color

date

The date and time (in ISO 8601 format) in the graph where the vertical annotation line is to appear.

fill

Add shading before or after the annotation.

Default:

No shading

label

Label for the annotation.

Default:
  • No label

visible

Whether the annotation is visible.

Default:

true