feat: the cloudformation-include module is now Generally Available (s…

…table) (#11882) As part of making the module stable, also deprecate the `CfnInclude` class from the core module. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Dec 4, 2020 · 11df56b · 11df56b
1 parent 45677ca
commit 11df56b
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 9 deletions.
diff --git a/packages/@aws-cdk/cloudformation-include/README.md b/packages/@aws-cdk/cloudformation-include/README.md
@@ -1,15 +1,10 @@
 # Include CloudFormation templates in the CDK
+
 <!--BEGIN STABILITY BANNER-->
 
 ---
 
-![cdk-constructs: Developer Preview](https://img.shields.io/badge/cdk--constructs-developer--preview-informational.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.
+![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)
 
 ---
 

diff --git a/packages/@aws-cdk/cloudformation-include/package.json b/packages/@aws-cdk/cloudformation-include/package.json
@@ -367,8 +367,8 @@
       "props-no-cfn-types:@aws-cdk/cloudformation-include.CfnIncludeProps.loadNestedStacks"
     ]
   },
-  "stability": "experimental",
-  "maturity": "developer-preview",
+  "stability": "stable",
+  "maturity": "stable",
   "awscdkio": {
     "announce": false
   }

diff --git a/packages/@aws-cdk/core/lib/cfn-include.ts b/packages/@aws-cdk/core/lib/cfn-include.ts
@@ -1,6 +1,11 @@
 import { Construct } from 'constructs';
 import { CfnElement } from './cfn-element';
 
+/**
+ * Construction properties for {@link CfnInclude}.
+ *
+ * @deprecated use the CfnInclude class from the cloudformation-include module instead
+ */
 export interface CfnIncludeProps {
   /**
    * The CloudFormation template to include in the stack (as is).
@@ -11,6 +16,8 @@ export interface CfnIncludeProps {
 /**
  * Includes a CloudFormation template into a stack. All elements of the template will be merged into
  * the current stack, together with any elements created programmatically.
+ *
+ * @deprecated use the CfnInclude class from the cloudformation-include module instead
  */
 export class CfnInclude extends CfnElement {
   /**