HorizontalAnnotation

class aws_cdk.aws_cloudwatch.HorizontalAnnotation(*, value, color=None, fill=None, label=None, visible=None)

Bases: object

Horizontal annotation to be added to a graph.

Parameters:
  • value (Union[int, float]) – The value of the annotation.

  • 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[Shading]) – Add shading above or below 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

horizontal_annotation = cloudwatch.HorizontalAnnotation(
    value=123,

    # the properties below are optional
    color="color",
    fill=cloudwatch.Shading.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

fill

Add shading above or below the annotation.

Default:

No shading

label

Label for the annotation.

Default:
  • No label

value

The value of the annotation.

visible

Whether the annotation is visible.

Default:

true