Python: Annotations

CDKTN Core API Reference for Annotations in Python.

Includes API for attaching annotations such as warning messages to constructs.

Methods

Name	Description
add_error	Adds an { “error”: < message > } metadata entry to this construct.
add_info	Adds an info metadata entry to this construct.
add_warning	Adds a warning metadata entry to this construct.

---

add_error

def add_error(
  message: str
) -> None

Adds an { “error”: < message > } metadata entry to this construct.

The toolkit will fail synthesis when errors are reported.

message^Required

• Type: str

The error message.

---

add_info

def add_info(
  message: str
) -> None

Adds an info metadata entry to this construct.

The CLI will display the info message when apps are synthesized.

message^Required

• Type: str

The info message.

---

add_warning

def add_warning(
  message: str
) -> None

Adds a warning metadata entry to this construct.

The CLI will display the warning when an app is synthesized. In a future release the CLI might introduce a —strict flag which will then fail the synthesis if it encounters a warning.

message^Required

• Type: str

The warning message.

---

Static Functions

Name	Description
of	Returns the annotations API for a construct scope.

---

of

import cdktn

cdktn.Annotations.of(
  scope: IConstruct
)

Returns the annotations API for a construct scope.

scope^Required

• Type: constructs.IConstruct

The scope.

---