A static website for the distribution of notices that we want to broadcast to AWS CDK users. This information can be used in different ways. For example, it can be consumed by the CDK CLI to display messages to users on every command, or it can be used by a GitHub workflow to update issues.
Notices are declared as JSON objects with the following structure:
Field | Description | Format |
---|---|---|
title |
The title of the incident (max length: 100) | Free form text |
issueNumber |
The ID of the GitHub issue where we are tracking this event | Number |
overview |
A paragraph with more information about the incident | Free form text |
components |
A list of the components affected by the incident | See table below |
schemaVersion |
The version of the schema used for this notice | String |
Component structure:
Field | Description | Format |
---|---|---|
name |
The name of the affected component | String¹ |
version |
The version range affected | Semantic version |
1: The name can be either:
- A fully qualified name of a construct (e.g.,
aws-cdk-lib.aws_amplify.CfnBranch
) - A prefix of a fully qualified name (e.g.,
aws-cdk-lib.aws_amplify.
). This will match a constructs with this prefix. Note the.
at the end. - The reserved word
cli
. This will match against the CDK CLI fetching the notices from the website. - The reserved word
framework
. This will match against the@aws-cdk/core
, in case of v1 oraws-cdk-lib
in case of v2.
Example:
{
"title": "<string>",
"issueNumber": 16603,
"overview": "If a stack is deployed with an S3 bucket with auto_delete_objects=True, and then re-deployed with auto_delete_objects=False, all the objects in the bucket will be deleted.",
"components": [{
"name": "framework",
"version": "<=1.125.0"
}],
"schemaVersion": "1"
}
This project is licensed under the Apache-2.0 License.