Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(synthetics): deprecate aws-synthetics-alpha #27471

Merged
merged 3 commits into from
Oct 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions packages/@aws-cdk/aws-synthetics-alpha/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,16 @@

---

![cdk-constructs: Developer Preview](https://img.shields.io/badge/cdk--constructs-developer--preview-informational.svg?style=for-the-badge)
![Deprecated](https://img.shields.io/badge/deprecated-critical.svg?style=for-the-badge)

> The APIs of higher level constructs in this module are in **developer preview** before they
> become stable. We will only make breaking changes to address unforeseen API issues. Therefore,
> these APIs are not subject to [Semantic Versioning](https://semver.org/), and breaking changes
> will be announced in release notes. This means that while you may use them, you may need to
> update your source code when upgrading to a newer version of this package.
> This API may emit warnings. Backward compatibility is not guaranteed.

---

<!--END STABILITY BANNER-->

All constructs moved to aws-cdk-lib/aws-synthetics.

Amazon CloudWatch Synthetics allow you to monitor your application by generating **synthetic** traffic. The traffic is produced by a **canary**: a configurable script that runs on a schedule. You configure the canary script to follow the same routes and perform the same actions as a user, which allows you to continually verify your user experience even when you don't have any traffic on your applications.

## Canary
Expand Down
9 changes: 5 additions & 4 deletions packages/@aws-cdk/aws-synthetics-alpha/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@aws-cdk/aws-synthetics-alpha",
"version": "0.0.0",
"private": false,
"description": "The CDK Construct Library for AWS::Synthetics",
"description": "This module is deprecated. All constructs are now available under aws-cdk-lib/aws-synthetics",
"main": "lib/index.js",
"types": "lib/index.d.ts",
"jsii": {
Expand Down Expand Up @@ -104,8 +104,8 @@
"engines": {
"node": ">= 14.15.0"
},
"stability": "experimental",
"maturity": "developer-preview",
"stability": "deprecated",
"maturity": "deprecated",
"awscdkio": {
"announce": false
},
Expand All @@ -117,5 +117,6 @@
"naming/package-matches-directory",
"assert/assert-dependency"
]
}
},
"deprecated": "This package has been stabilized in aws-cdk-lib is no longer being updated under the -alpha name. Users should migrate to aws-<module> in aws-cdk-lib."
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm going to try this. if jsii / npm does the deprecation for us, great. if not, then i will follow up and do it manually

}