From da94d8b109b391b926e35951d426b8308a75896e Mon Sep 17 00:00:00 2001 From: Romain Marcadier-Muller Date: Thu, 6 Jun 2019 11:45:53 +0200 Subject: [PATCH] fix(pkglint): Adjust stability banner style (#2768) GitHub markdown does not allow use of inline CSS on `
` elements, resulting in a poor looking `README.md` experience on the website. Adjusted the style to use a blockquote in order to have the stability indication stand out more, while being visually pleasant. --- packages/@aws-cdk/alexa-ask/README.md | 17 +++++++---- packages/@aws-cdk/app-delivery/README.md | 18 +++++++---- packages/@aws-cdk/assert/README.md | 17 +++++++---- packages/@aws-cdk/assets-docker/README.md | 17 +++++++---- packages/@aws-cdk/assets/README.md | 17 +++++++---- packages/@aws-cdk/aws-amazonmq/README.md | 17 +++++++---- packages/@aws-cdk/aws-apigateway/README.md | 17 +++++++---- .../aws-applicationautoscaling/README.md | 17 +++++++---- packages/@aws-cdk/aws-appmesh/README.md | 17 +++++++---- packages/@aws-cdk/aws-appstream/README.md | 17 +++++++---- packages/@aws-cdk/aws-appsync/README.md | 18 +++++++---- packages/@aws-cdk/aws-athena/README.md | 18 +++++++---- .../@aws-cdk/aws-autoscaling-common/README.md | 17 +++++++---- .../aws-autoscaling-hooktargets/README.md | 17 +++++++---- packages/@aws-cdk/aws-autoscaling/README.md | 18 +++++++---- .../@aws-cdk/aws-autoscalingplans/README.md | 18 +++++++---- packages/@aws-cdk/aws-batch/README.md | 18 +++++++---- packages/@aws-cdk/aws-budgets/README.md | 18 +++++++---- .../@aws-cdk/aws-certificatemanager/README.md | 17 +++++++---- packages/@aws-cdk/aws-cloud9/README.md | 18 +++++++---- .../@aws-cdk/aws-cloudformation/README.md | 17 +++++++---- packages/@aws-cdk/aws-cloudfront/README.md | 18 +++++++---- packages/@aws-cdk/aws-cloudtrail/README.md | 18 +++++++---- .../@aws-cdk/aws-cloudwatch-actions/README.md | 17 +++++++---- packages/@aws-cdk/aws-cloudwatch/README.md | 17 +++++++---- packages/@aws-cdk/aws-codebuild/README.md | 17 +++++++---- packages/@aws-cdk/aws-codecommit/README.md | 17 +++++++---- packages/@aws-cdk/aws-codedeploy/README.md | 17 +++++++---- .../aws-codepipeline-actions/README.md | 17 +++++++---- packages/@aws-cdk/aws-codepipeline/README.md | 17 +++++++---- packages/@aws-cdk/aws-cognito/README.md | 18 +++++++---- packages/@aws-cdk/aws-config/README.md | 18 +++++++---- packages/@aws-cdk/aws-datapipeline/README.md | 18 +++++++---- packages/@aws-cdk/aws-dax/README.md | 18 +++++++---- .../@aws-cdk/aws-directoryservice/README.md | 18 +++++++---- packages/@aws-cdk/aws-dlm/README.md | 17 +++++++---- packages/@aws-cdk/aws-dms/README.md | 18 +++++++---- packages/@aws-cdk/aws-docdb/README.md | 17 +++++++---- .../@aws-cdk/aws-dynamodb-global/README.md | 17 +++++++---- packages/@aws-cdk/aws-dynamodb/README.md | 17 +++++++---- packages/@aws-cdk/aws-ec2/README.md | 17 +++++++---- packages/@aws-cdk/aws-ecr/README.md | 17 +++++++---- packages/@aws-cdk/aws-ecs-patterns/README.md | 17 +++++++---- packages/@aws-cdk/aws-ecs/README.md | 17 +++++++---- packages/@aws-cdk/aws-efs/README.md | 18 +++++++---- packages/@aws-cdk/aws-eks/README.md | 17 +++++++---- packages/@aws-cdk/aws-elasticache/README.md | 18 +++++++---- .../@aws-cdk/aws-elasticbeanstalk/README.md | 18 +++++++---- .../aws-elasticloadbalancing/README.md | 17 +++++++---- .../aws-elasticloadbalancingv2/README.md | 17 +++++++---- packages/@aws-cdk/aws-elasticsearch/README.md | 18 +++++++---- packages/@aws-cdk/aws-emr/README.md | 18 +++++++---- .../@aws-cdk/aws-events-targets/README.md | 17 +++++++---- packages/@aws-cdk/aws-events/README.md | 17 +++++++---- packages/@aws-cdk/aws-fsx/README.md | 17 +++++++---- packages/@aws-cdk/aws-gamelift/README.md | 18 +++++++---- packages/@aws-cdk/aws-glue/README.md | 18 +++++++---- packages/@aws-cdk/aws-greengrass/README.md | 17 +++++++---- packages/@aws-cdk/aws-guardduty/README.md | 18 +++++++---- packages/@aws-cdk/aws-iam/README.md | 17 +++++++---- packages/@aws-cdk/aws-inspector/README.md | 18 +++++++---- packages/@aws-cdk/aws-iot/README.md | 18 +++++++---- packages/@aws-cdk/aws-iot1click/README.md | 17 +++++++---- packages/@aws-cdk/aws-iotanalytics/README.md | 17 +++++++---- packages/@aws-cdk/aws-kinesis/README.md | 17 +++++++---- .../@aws-cdk/aws-kinesisanalytics/README.md | 18 +++++++---- .../@aws-cdk/aws-kinesisfirehose/README.md | 18 +++++++---- packages/@aws-cdk/aws-kms/README.md | 17 +++++++---- .../aws-lambda-event-sources/README.md | 17 +++++++---- packages/@aws-cdk/aws-lambda/README.md | 17 +++++++---- .../@aws-cdk/aws-logs-destinations/README.md | 17 +++++++---- packages/@aws-cdk/aws-logs/README.md | 17 +++++++---- packages/@aws-cdk/aws-mediastore/README.md | 17 +++++++---- packages/@aws-cdk/aws-neptune/README.md | 17 +++++++---- packages/@aws-cdk/aws-opsworks/README.md | 18 +++++++---- packages/@aws-cdk/aws-opsworkscm/README.md | 17 +++++++---- packages/@aws-cdk/aws-pinpointemail/README.md | 17 +++++++---- packages/@aws-cdk/aws-quickstarts/README.md | 13 +++++--- packages/@aws-cdk/aws-ram/README.md | 17 +++++++---- packages/@aws-cdk/aws-rds/README.md | 17 +++++++---- packages/@aws-cdk/aws-redshift/README.md | 18 +++++++---- packages/@aws-cdk/aws-robomaker/README.md | 17 +++++++---- .../@aws-cdk/aws-route53-targets/README.md | 17 +++++++---- packages/@aws-cdk/aws-route53/README.md | 17 +++++++---- .../@aws-cdk/aws-route53resolver/README.md | 17 +++++++---- packages/@aws-cdk/aws-s3-deployment/README.md | 17 +++++++---- .../@aws-cdk/aws-s3-notifications/README.md | 17 +++++++---- packages/@aws-cdk/aws-s3/README.md | 17 +++++++---- packages/@aws-cdk/aws-sagemaker/README.md | 17 +++++++---- packages/@aws-cdk/aws-sam/README.md | 17 +++++++---- packages/@aws-cdk/aws-sdb/README.md | 18 +++++++---- .../@aws-cdk/aws-secretsmanager/README.md | 17 +++++++---- .../@aws-cdk/aws-servicecatalog/README.md | 18 +++++++---- .../@aws-cdk/aws-servicediscovery/README.md | 18 +++++++---- packages/@aws-cdk/aws-ses/README.md | 18 +++++++---- packages/@aws-cdk/aws-sns/README.md | 17 +++++++---- packages/@aws-cdk/aws-sqs/README.md | 17 +++++++---- packages/@aws-cdk/aws-ssm/README.md | 18 +++++++---- .../aws-stepfunctions-tasks/README.md | 17 +++++++---- packages/@aws-cdk/aws-stepfunctions/README.md | 17 +++++++---- packages/@aws-cdk/aws-transfer/README.md | 17 +++++++---- packages/@aws-cdk/aws-waf/README.md | 18 +++++++---- packages/@aws-cdk/aws-wafregional/README.md | 18 +++++++---- packages/@aws-cdk/aws-workspaces/README.md | 18 +++++++---- packages/@aws-cdk/cdk/README.md | 17 +++++++---- .../@aws-cdk/cloudformation-diff/README.md | 18 +++++++---- packages/@aws-cdk/cx-api/README.md | 18 +++++++---- packages/@aws-cdk/region-info/README.md | 18 +++++++---- packages/@aws-cdk/runtime-values/README.md | 13 +++++--- packages/aws-cdk/README.md | 18 +++++++---- packages/simple-resource-bundler/README.md | 13 +++++--- tools/pkglint/lib/rules.ts | 30 +++++++++++-------- 112 files changed, 1275 insertions(+), 672 deletions(-) diff --git a/packages/@aws-cdk/alexa-ask/README.md b/packages/@aws-cdk/alexa-ask/README.md index c1b9bd7cf3914..dadcfbeb97070 100644 --- a/packages/@aws-cdk/alexa-ask/README.md +++ b/packages/@aws-cdk/alexa-ask/README.md @@ -1,11 +1,16 @@ ## Alexa Skills Kit Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts const alexaAsk = require('@aws-cdk/alexa-ask'); diff --git a/packages/@aws-cdk/app-delivery/README.md b/packages/@aws-cdk/app-delivery/README.md index 68e01dd2dc6de..740ec8ead94c0 100644 --- a/packages/@aws-cdk/app-delivery/README.md +++ b/packages/@aws-cdk/app-delivery/README.md @@ -1,10 +1,16 @@ ## Continuous Integration / Continuous Delivery for CDK Applications -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This library includes a *CodePipeline* composite Action for deploying AWS CDK Applications. diff --git a/packages/@aws-cdk/assert/README.md b/packages/@aws-cdk/assert/README.md index f2e3c3c6c513e..530f4af64a9ca 100644 --- a/packages/@aws-cdk/assert/README.md +++ b/packages/@aws-cdk/assert/README.md @@ -1,11 +1,16 @@ ## Testing utilities and assertions for CDK libraries -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This library contains helpers for writing unit tests and integration tests for CDK libraries diff --git a/packages/@aws-cdk/assets-docker/README.md b/packages/@aws-cdk/assets-docker/README.md index 54c167533bc93..2dc56b8ae3139 100644 --- a/packages/@aws-cdk/assets-docker/README.md +++ b/packages/@aws-cdk/assets-docker/README.md @@ -1,11 +1,16 @@ # AWS CDK Docker Image Assets -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module allows bundling Docker images as assets. diff --git a/packages/@aws-cdk/assets/README.md b/packages/@aws-cdk/assets/README.md index f7bf68823305d..6c84d2da11981 100644 --- a/packages/@aws-cdk/assets/README.md +++ b/packages/@aws-cdk/assets/README.md @@ -1,11 +1,16 @@ ## AWS CDK Assets -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Assets are local files or directories which are needed by a CDK app. A common example is a directory which contains the handler code for a Lambda function, diff --git a/packages/@aws-cdk/aws-amazonmq/README.md b/packages/@aws-cdk/aws-amazonmq/README.md index a868e59050924..acf21ffde4825 100644 --- a/packages/@aws-cdk/aws-amazonmq/README.md +++ b/packages/@aws-cdk/aws-amazonmq/README.md @@ -1,11 +1,16 @@ ## Amazon MQ Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts const amazonmq = require('@aws-cdk/aws-amazonmq'); diff --git a/packages/@aws-cdk/aws-apigateway/README.md b/packages/@aws-cdk/aws-apigateway/README.md index 981860b78dc36..bb0aee504cc19 100644 --- a/packages/@aws-cdk/aws-apigateway/README.md +++ b/packages/@aws-cdk/aws-apigateway/README.md @@ -1,11 +1,16 @@ ## Amazon API Gateway Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Amazon API Gateway is a fully managed service that makes it easy for developers to publish, maintain, monitor, and secure APIs at any scale. Create an API to diff --git a/packages/@aws-cdk/aws-applicationautoscaling/README.md b/packages/@aws-cdk/aws-applicationautoscaling/README.md index fb0462ea44f93..bbc97e110f82f 100644 --- a/packages/@aws-cdk/aws-applicationautoscaling/README.md +++ b/packages/@aws-cdk/aws-applicationautoscaling/README.md @@ -1,11 +1,16 @@ ## AWS Auto Scaling Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + **Application AutoScaling** is used to configure autoscaling for all services other than scaling EC2 instances. For example, you will use this to diff --git a/packages/@aws-cdk/aws-appmesh/README.md b/packages/@aws-cdk/aws-appmesh/README.md index 8350163821b76..b42654a4ac66d 100644 --- a/packages/@aws-cdk/aws-appmesh/README.md +++ b/packages/@aws-cdk/aws-appmesh/README.md @@ -1,11 +1,16 @@ ## AWS App Mesh Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-appstream/README.md b/packages/@aws-cdk/aws-appstream/README.md index 91e0ee48b1da2..a32eecb657833 100644 --- a/packages/@aws-cdk/aws-appstream/README.md +++ b/packages/@aws-cdk/aws-appstream/README.md @@ -1,11 +1,16 @@ ## Amazon AppStream 2.0 Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts const appstream = require('@aws-cdk/aws-appstream'); diff --git a/packages/@aws-cdk/aws-appsync/README.md b/packages/@aws-cdk/aws-appsync/README.md index b2020a5eaf5fc..2d650f0519a5c 100644 --- a/packages/@aws-cdk/aws-appsync/README.md +++ b/packages/@aws-cdk/aws-appsync/README.md @@ -1,9 +1,15 @@ ## AWS AppSync Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-athena/README.md b/packages/@aws-cdk/aws-athena/README.md index 64a73d5fb7256..ed1f2e5b57052 100644 --- a/packages/@aws-cdk/aws-athena/README.md +++ b/packages/@aws-cdk/aws-athena/README.md @@ -1,9 +1,15 @@ ## Amazon Athena Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-autoscaling-common/README.md b/packages/@aws-cdk/aws-autoscaling-common/README.md index 645391ce1776d..219988d182261 100644 --- a/packages/@aws-cdk/aws-autoscaling-common/README.md +++ b/packages/@aws-cdk/aws-autoscaling-common/README.md @@ -1,11 +1,16 @@ ## AWS AutoScaling Common Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This is a sister package to `@aws-cdk/aws-autoscaling` and `@aws-cdk/aws-applicationautoscaling`. It contains shared implementation diff --git a/packages/@aws-cdk/aws-autoscaling-hooktargets/README.md b/packages/@aws-cdk/aws-autoscaling-hooktargets/README.md index 2182be9daac70..1806f0a1831a3 100644 --- a/packages/@aws-cdk/aws-autoscaling-hooktargets/README.md +++ b/packages/@aws-cdk/aws-autoscaling-hooktargets/README.md @@ -1,10 +1,15 @@ # Lifecycle Hook for the CDK AWS AutoScaling Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + See the README of the `@aws-cdk/aws-autoscaling` library. diff --git a/packages/@aws-cdk/aws-autoscaling/README.md b/packages/@aws-cdk/aws-autoscaling/README.md index e348c98661b3a..194f224097cb9 100644 --- a/packages/@aws-cdk/aws-autoscaling/README.md +++ b/packages/@aws-cdk/aws-autoscaling/README.md @@ -1,10 +1,16 @@ ## Amazon EC2 Auto Scaling Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-autoscalingplans/README.md b/packages/@aws-cdk/aws-autoscalingplans/README.md index 1c1338e2deb37..657a8d541947a 100644 --- a/packages/@aws-cdk/aws-autoscalingplans/README.md +++ b/packages/@aws-cdk/aws-autoscalingplans/README.md @@ -1,9 +1,15 @@ ## AWS Auto Scaling Plans Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-batch/README.md b/packages/@aws-cdk/aws-batch/README.md index b40690ef8b204..eb74c0203a14f 100644 --- a/packages/@aws-cdk/aws-batch/README.md +++ b/packages/@aws-cdk/aws-batch/README.md @@ -1,9 +1,15 @@ ## AWS Batch Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-budgets/README.md b/packages/@aws-cdk/aws-budgets/README.md index ccc1353917bd3..f5baecafa8507 100644 --- a/packages/@aws-cdk/aws-budgets/README.md +++ b/packages/@aws-cdk/aws-budgets/README.md @@ -1,9 +1,15 @@ ## AWS Budgets Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-certificatemanager/README.md b/packages/@aws-cdk/aws-certificatemanager/README.md index e8c07bcf97bc3..9ce310ff72904 100644 --- a/packages/@aws-cdk/aws-certificatemanager/README.md +++ b/packages/@aws-cdk/aws-certificatemanager/README.md @@ -1,11 +1,16 @@ ## Amazon Certificate Manager Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This package provides Constructs for provisioning and referencing certificates which can be used in CloudFront and ELB. diff --git a/packages/@aws-cdk/aws-cloud9/README.md b/packages/@aws-cdk/aws-cloud9/README.md index bf38186833f3e..f3644d8b3e3b7 100644 --- a/packages/@aws-cdk/aws-cloud9/README.md +++ b/packages/@aws-cdk/aws-cloud9/README.md @@ -1,9 +1,15 @@ ## AWS Cloud9 Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-cloudformation/README.md b/packages/@aws-cdk/aws-cloudformation/README.md index 91b00829f0487..ababba8230031 100644 --- a/packages/@aws-cdk/aws-cloudformation/README.md +++ b/packages/@aws-cdk/aws-cloudformation/README.md @@ -1,11 +1,16 @@ ## AWS CloudFormation Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-cloudfront/README.md b/packages/@aws-cdk/aws-cloudfront/README.md index 96570b4096f88..ea8e10fdab810 100644 --- a/packages/@aws-cdk/aws-cloudfront/README.md +++ b/packages/@aws-cdk/aws-cloudfront/README.md @@ -1,10 +1,16 @@ ## Amazon CloudFront Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + A CloudFront construct - for setting up the AWS CDN with ease! diff --git a/packages/@aws-cdk/aws-cloudtrail/README.md b/packages/@aws-cdk/aws-cloudtrail/README.md index 14d3042bcdf32..8bfa4f7511a8e 100644 --- a/packages/@aws-cdk/aws-cloudtrail/README.md +++ b/packages/@aws-cdk/aws-cloudtrail/README.md @@ -1,10 +1,16 @@ ## AWS CloudTrail Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Add a CloudTrail construct - for ease of setting up CloudTrail logging in your account diff --git a/packages/@aws-cdk/aws-cloudwatch-actions/README.md b/packages/@aws-cdk/aws-cloudwatch-actions/README.md index ddbeaed0210d9..b2b712a2c5dce 100644 --- a/packages/@aws-cdk/aws-cloudwatch-actions/README.md +++ b/packages/@aws-cdk/aws-cloudwatch-actions/README.md @@ -1,11 +1,16 @@ # CloudWatch Alarm Actions library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This library contains a set of classes which can be used as CloudWatch Alarm actions. diff --git a/packages/@aws-cdk/aws-cloudwatch/README.md b/packages/@aws-cdk/aws-cloudwatch/README.md index 58f0e85f17f36..5b8fe7ef87354 100644 --- a/packages/@aws-cdk/aws-cloudwatch/README.md +++ b/packages/@aws-cdk/aws-cloudwatch/README.md @@ -1,11 +1,16 @@ ## Amazon CloudWatch Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Metric objects represent a metric that is emitted by AWS services or your own application, such as `CPUUsage`, `FailureCount` or `Bandwidth`. diff --git a/packages/@aws-cdk/aws-codebuild/README.md b/packages/@aws-cdk/aws-codebuild/README.md index 6ecf283cdc0b9..1d20e66e2d3ea 100644 --- a/packages/@aws-cdk/aws-codebuild/README.md +++ b/packages/@aws-cdk/aws-codebuild/README.md @@ -1,11 +1,16 @@ ## AWS CodeBuild Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + AWS CodeBuild is a fully managed continuous integration service that compiles source code, runs tests, and produces software packages that are ready to diff --git a/packages/@aws-cdk/aws-codecommit/README.md b/packages/@aws-cdk/aws-codecommit/README.md index b346449bf3736..caa0231218043 100644 --- a/packages/@aws-cdk/aws-codecommit/README.md +++ b/packages/@aws-cdk/aws-codecommit/README.md @@ -1,11 +1,16 @@ ## AWS CodeCommit Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + AWS CodeCommit is a version control service that enables you to privately store and manage Git repositories in the AWS cloud. diff --git a/packages/@aws-cdk/aws-codedeploy/README.md b/packages/@aws-cdk/aws-codedeploy/README.md index 97945db7ae546..5c43b171885d3 100644 --- a/packages/@aws-cdk/aws-codedeploy/README.md +++ b/packages/@aws-cdk/aws-codedeploy/README.md @@ -1,11 +1,16 @@ ## AWS CodeDeploy Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances, serverless Lambda functions, or Amazon ECS services. diff --git a/packages/@aws-cdk/aws-codepipeline-actions/README.md b/packages/@aws-cdk/aws-codepipeline-actions/README.md index c9d513958aba3..7335c689bc925 100644 --- a/packages/@aws-cdk/aws-codepipeline-actions/README.md +++ b/packages/@aws-cdk/aws-codepipeline-actions/README.md @@ -1,11 +1,16 @@ ## AWS CodePipeline Actions -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This package contains Actions that can be used in a CodePipeline. diff --git a/packages/@aws-cdk/aws-codepipeline/README.md b/packages/@aws-cdk/aws-codepipeline/README.md index 0ab349f50cb0b..8df3bef71fa5d 100644 --- a/packages/@aws-cdk/aws-codepipeline/README.md +++ b/packages/@aws-cdk/aws-codepipeline/README.md @@ -1,11 +1,16 @@ ## AWS CodePipeline Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ### Pipeline diff --git a/packages/@aws-cdk/aws-cognito/README.md b/packages/@aws-cdk/aws-cognito/README.md index a57efaa13ff49..b4198d544f976 100644 --- a/packages/@aws-cdk/aws-cognito/README.md +++ b/packages/@aws-cdk/aws-cognito/README.md @@ -1,9 +1,15 @@ ## Amazon Cognito Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-config/README.md b/packages/@aws-cdk/aws-config/README.md index a189024cceaf5..2313e1c3d2f62 100644 --- a/packages/@aws-cdk/aws-config/README.md +++ b/packages/@aws-cdk/aws-config/README.md @@ -1,10 +1,16 @@ ## AWS Config Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-datapipeline/README.md b/packages/@aws-cdk/aws-datapipeline/README.md index 9ac2eafab9f71..715b9db29d5b1 100644 --- a/packages/@aws-cdk/aws-datapipeline/README.md +++ b/packages/@aws-cdk/aws-datapipeline/README.md @@ -1,9 +1,15 @@ ## AWS Data Pipeline Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-dax/README.md b/packages/@aws-cdk/aws-dax/README.md index 0045673f891cc..19c73b9745281 100644 --- a/packages/@aws-cdk/aws-dax/README.md +++ b/packages/@aws-cdk/aws-dax/README.md @@ -1,9 +1,15 @@ ## Amazon DynamoDB Accelerator Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-directoryservice/README.md b/packages/@aws-cdk/aws-directoryservice/README.md index a265a7d9ed882..4704563f04679 100644 --- a/packages/@aws-cdk/aws-directoryservice/README.md +++ b/packages/@aws-cdk/aws-directoryservice/README.md @@ -1,9 +1,15 @@ ## AWS Directory Service Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-dlm/README.md b/packages/@aws-cdk/aws-dlm/README.md index 12aa9069c135d..0a9d48f068025 100644 --- a/packages/@aws-cdk/aws-dlm/README.md +++ b/packages/@aws-cdk/aws-dlm/README.md @@ -1,11 +1,16 @@ ## Amazon Data Lifecycle Manager Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts const dlm = require('@aws-cdk/aws-dlm'); diff --git a/packages/@aws-cdk/aws-dms/README.md b/packages/@aws-cdk/aws-dms/README.md index d25c9183ae058..3be5afa6581b0 100644 --- a/packages/@aws-cdk/aws-dms/README.md +++ b/packages/@aws-cdk/aws-dms/README.md @@ -1,9 +1,15 @@ ## AWS Database Migration Service Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-docdb/README.md b/packages/@aws-cdk/aws-docdb/README.md index 5a4bcc13f69d0..4a932a259538c 100644 --- a/packages/@aws-cdk/aws-docdb/README.md +++ b/packages/@aws-cdk/aws-docdb/README.md @@ -1,11 +1,16 @@ ## Amazon DocumentDB Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-dynamodb-global/README.md b/packages/@aws-cdk/aws-dynamodb-global/README.md index 3b5fcbb14e57e..3edf3b9d6f288 100644 --- a/packages/@aws-cdk/aws-dynamodb-global/README.md +++ b/packages/@aws-cdk/aws-dynamodb-global/README.md @@ -1,11 +1,16 @@ ## @aws-cdk/aws-dynamodb-global -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Global Tables builds upon DynamoDB’s global footprint to provide you with a fully managed, multi-region, and multi-master database that provides fast, local, read and write performance for massively scaled, global applications. Global Tables replicates your Amazon DynamoDB tables automatically across your choice of AWS regions. diff --git a/packages/@aws-cdk/aws-dynamodb/README.md b/packages/@aws-cdk/aws-dynamodb/README.md index 5c0bc723eba50..941281c1e5edc 100644 --- a/packages/@aws-cdk/aws-dynamodb/README.md +++ b/packages/@aws-cdk/aws-dynamodb/README.md @@ -1,11 +1,16 @@ ## Amazon DynamoDB Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Here is a minimal deployable DynamoDB table definition: diff --git a/packages/@aws-cdk/aws-ec2/README.md b/packages/@aws-cdk/aws-ec2/README.md index 46037b1dacc20..526f154d56fb9 100644 --- a/packages/@aws-cdk/aws-ec2/README.md +++ b/packages/@aws-cdk/aws-ec2/README.md @@ -1,11 +1,16 @@ ## Amazon EC2 Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + The `@aws-cdk/aws-ec2` package contains primitives for setting up networking and instances. diff --git a/packages/@aws-cdk/aws-ecr/README.md b/packages/@aws-cdk/aws-ecr/README.md index 84c8cdb67d8f8..3ee13d825d678 100644 --- a/packages/@aws-cdk/aws-ecr/README.md +++ b/packages/@aws-cdk/aws-ecr/README.md @@ -1,11 +1,16 @@ ## Amazon ECR Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This package contains constructs for working with Amazon Elastic Container Registry. diff --git a/packages/@aws-cdk/aws-ecs-patterns/README.md b/packages/@aws-cdk/aws-ecs-patterns/README.md index 8bdfafcc9938b..e36e7a6f22a12 100644 --- a/packages/@aws-cdk/aws-ecs-patterns/README.md +++ b/packages/@aws-cdk/aws-ecs-patterns/README.md @@ -1,11 +1,16 @@ # CDK Construct library for higher-level ECS Constructs -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This library provides higher-level ECS constructs which follow common architectural patterns. It contains: diff --git a/packages/@aws-cdk/aws-ecs/README.md b/packages/@aws-cdk/aws-ecs/README.md index 3b365cc6d67d6..61de7c2385a53 100644 --- a/packages/@aws-cdk/aws-ecs/README.md +++ b/packages/@aws-cdk/aws-ecs/README.md @@ -1,11 +1,16 @@ ## Amazon ECS Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This package contains constructs for working with **Amazon Elastic Container Service** (Amazon ECS). diff --git a/packages/@aws-cdk/aws-efs/README.md b/packages/@aws-cdk/aws-efs/README.md index e602ce6902d97..e774a933c8d54 100644 --- a/packages/@aws-cdk/aws-efs/README.md +++ b/packages/@aws-cdk/aws-efs/README.md @@ -1,9 +1,15 @@ ## Amazon Elastic File System Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-eks/README.md b/packages/@aws-cdk/aws-eks/README.md index e7b086d8ef44a..5c7eb6b059dbc 100644 --- a/packages/@aws-cdk/aws-eks/README.md +++ b/packages/@aws-cdk/aws-eks/README.md @@ -1,11 +1,16 @@ ## Amazon EKS Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This construct library allows you to define and create [Amazon Elastic Container Service for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters programmatically. diff --git a/packages/@aws-cdk/aws-elasticache/README.md b/packages/@aws-cdk/aws-elasticache/README.md index 6b061edebc824..a246e93f968eb 100644 --- a/packages/@aws-cdk/aws-elasticache/README.md +++ b/packages/@aws-cdk/aws-elasticache/README.md @@ -1,9 +1,15 @@ ## Amazon ElastiCache Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-elasticbeanstalk/README.md b/packages/@aws-cdk/aws-elasticbeanstalk/README.md index ee4b3eb8b4324..f49b1081c508c 100644 --- a/packages/@aws-cdk/aws-elasticbeanstalk/README.md +++ b/packages/@aws-cdk/aws-elasticbeanstalk/README.md @@ -1,9 +1,15 @@ ## AWS Elastic Beanstalk Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-elasticloadbalancing/README.md b/packages/@aws-cdk/aws-elasticloadbalancing/README.md index aa199d50c6f3e..f16ae0c7778ae 100644 --- a/packages/@aws-cdk/aws-elasticloadbalancing/README.md +++ b/packages/@aws-cdk/aws-elasticloadbalancing/README.md @@ -1,11 +1,16 @@ ## Amazon Elastic Load Balancing Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + The `@aws-cdk/aws-ec2` package provides constructs for configuring classic load balancers. diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/README.md b/packages/@aws-cdk/aws-elasticloadbalancingv2/README.md index a6b5d29762d74..8a9a3bfbe513d 100644 --- a/packages/@aws-cdk/aws-elasticloadbalancingv2/README.md +++ b/packages/@aws-cdk/aws-elasticloadbalancingv2/README.md @@ -1,11 +1,16 @@ ## Amazon Elastic Load Balancing V2 Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + The `@aws-cdk/aws-elasticloadbalancingv2` package provides constructs for configuring application and network load balancers. diff --git a/packages/@aws-cdk/aws-elasticsearch/README.md b/packages/@aws-cdk/aws-elasticsearch/README.md index fdfb18d398a7e..b24bc40e9cc43 100644 --- a/packages/@aws-cdk/aws-elasticsearch/README.md +++ b/packages/@aws-cdk/aws-elasticsearch/README.md @@ -1,9 +1,15 @@ ## Amazon Elasticsearch Service Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-emr/README.md b/packages/@aws-cdk/aws-emr/README.md index 95090e166de0a..5cbb64eb51b0f 100644 --- a/packages/@aws-cdk/aws-emr/README.md +++ b/packages/@aws-cdk/aws-emr/README.md @@ -1,9 +1,15 @@ ## Amazon EMR Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-events-targets/README.md b/packages/@aws-cdk/aws-events-targets/README.md index 9a2d4426cc095..97eb01d17eeea 100644 --- a/packages/@aws-cdk/aws-events-targets/README.md +++ b/packages/@aws-cdk/aws-events-targets/README.md @@ -1,11 +1,16 @@ # Event Targets for AWS CloudWatch Events -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + See the README of the `@aws-cdk/aws-events` library. diff --git a/packages/@aws-cdk/aws-events/README.md b/packages/@aws-cdk/aws-events/README.md index 1350f18e51dae..12736a2c0132a 100644 --- a/packages/@aws-cdk/aws-events/README.md +++ b/packages/@aws-cdk/aws-events/README.md @@ -1,11 +1,16 @@ ## Amazon CloudWatch Events Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Amazon CloudWatch Events delivers a near real-time stream of system events that describe changes in AWS resources. For example, an AWS CodePipeline emits the diff --git a/packages/@aws-cdk/aws-fsx/README.md b/packages/@aws-cdk/aws-fsx/README.md index a8ff58cde90c8..3a41090701f82 100644 --- a/packages/@aws-cdk/aws-fsx/README.md +++ b/packages/@aws-cdk/aws-fsx/README.md @@ -1,11 +1,16 @@ ## Amazon FSx Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-gamelift/README.md b/packages/@aws-cdk/aws-gamelift/README.md index e08b2e5953496..e2cc6fff471b1 100644 --- a/packages/@aws-cdk/aws-gamelift/README.md +++ b/packages/@aws-cdk/aws-gamelift/README.md @@ -1,9 +1,15 @@ ## Amazon GameLift Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-glue/README.md b/packages/@aws-cdk/aws-glue/README.md index 913e6d5b6ebde..894935e3caa7e 100644 --- a/packages/@aws-cdk/aws-glue/README.md +++ b/packages/@aws-cdk/aws-glue/README.md @@ -1,10 +1,16 @@ ## AWS Glue Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-greengrass/README.md b/packages/@aws-cdk/aws-greengrass/README.md index 20aba4ac99752..b559070460ac7 100644 --- a/packages/@aws-cdk/aws-greengrass/README.md +++ b/packages/@aws-cdk/aws-greengrass/README.md @@ -1,11 +1,16 @@ ## AWS IoT Greengrass Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-guardduty/README.md b/packages/@aws-cdk/aws-guardduty/README.md index 653a4fbfb2b35..bb7695a720dd7 100644 --- a/packages/@aws-cdk/aws-guardduty/README.md +++ b/packages/@aws-cdk/aws-guardduty/README.md @@ -1,9 +1,15 @@ ## Amazon GuardDuty Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-iam/README.md b/packages/@aws-cdk/aws-iam/README.md index 4a3620d3865b6..30ec76bd767dc 100644 --- a/packages/@aws-cdk/aws-iam/README.md +++ b/packages/@aws-cdk/aws-iam/README.md @@ -1,11 +1,16 @@ ## AWS Identity and Access Management Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Define a role and add permissions to it. This will automatically create and attach an IAM policy to the role: diff --git a/packages/@aws-cdk/aws-inspector/README.md b/packages/@aws-cdk/aws-inspector/README.md index 2fe20b177d2d1..7c57224cc360a 100644 --- a/packages/@aws-cdk/aws-inspector/README.md +++ b/packages/@aws-cdk/aws-inspector/README.md @@ -1,9 +1,15 @@ ## Amazon Inspector Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-iot/README.md b/packages/@aws-cdk/aws-iot/README.md index b29ebd7107612..61564a42db552 100644 --- a/packages/@aws-cdk/aws-iot/README.md +++ b/packages/@aws-cdk/aws-iot/README.md @@ -1,9 +1,15 @@ ## AWS IoT Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-iot1click/README.md b/packages/@aws-cdk/aws-iot1click/README.md index a704d0d237a83..993d7126c4ee0 100644 --- a/packages/@aws-cdk/aws-iot1click/README.md +++ b/packages/@aws-cdk/aws-iot1click/README.md @@ -1,11 +1,16 @@ ## AWS IoT 1-Click Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts const iot1click = require('@aws-cdk/aws-iot1click'); diff --git a/packages/@aws-cdk/aws-iotanalytics/README.md b/packages/@aws-cdk/aws-iotanalytics/README.md index 2f1f594a787d5..d89a8778effdc 100644 --- a/packages/@aws-cdk/aws-iotanalytics/README.md +++ b/packages/@aws-cdk/aws-iotanalytics/README.md @@ -1,11 +1,16 @@ ## AWS IoT Analytics Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts import iotanalytics = require('@aws-cdk/aws-iotanalytics'); diff --git a/packages/@aws-cdk/aws-kinesis/README.md b/packages/@aws-cdk/aws-kinesis/README.md index d29af40dc5e62..8a3c723275938 100644 --- a/packages/@aws-cdk/aws-kinesis/README.md +++ b/packages/@aws-cdk/aws-kinesis/README.md @@ -1,11 +1,16 @@ ## Amazon Kinesis Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Define an unencrypted Kinesis stream. diff --git a/packages/@aws-cdk/aws-kinesisanalytics/README.md b/packages/@aws-cdk/aws-kinesisanalytics/README.md index ba1715a875ca8..49b39fe5e1b88 100644 --- a/packages/@aws-cdk/aws-kinesisanalytics/README.md +++ b/packages/@aws-cdk/aws-kinesisanalytics/README.md @@ -1,9 +1,15 @@ ## Amazon Kinesis Data Analytics Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-kinesisfirehose/README.md b/packages/@aws-cdk/aws-kinesisfirehose/README.md index cbcf0e5451701..fb08618ee4a51 100644 --- a/packages/@aws-cdk/aws-kinesisfirehose/README.md +++ b/packages/@aws-cdk/aws-kinesisfirehose/README.md @@ -1,9 +1,15 @@ ## Amazon Kinesis Data Firehose Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-kms/README.md b/packages/@aws-cdk/aws-kms/README.md index 77cc686db0cbe..6689b5a2a7f9a 100644 --- a/packages/@aws-cdk/aws-kms/README.md +++ b/packages/@aws-cdk/aws-kms/README.md @@ -1,11 +1,16 @@ ## AWS Key Management Service Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Defines a KMS key: diff --git a/packages/@aws-cdk/aws-lambda-event-sources/README.md b/packages/@aws-cdk/aws-lambda-event-sources/README.md index e9b03fda76ba9..30844721d2545 100644 --- a/packages/@aws-cdk/aws-lambda-event-sources/README.md +++ b/packages/@aws-cdk/aws-lambda-event-sources/README.md @@ -1,11 +1,16 @@ ## AWS Lambda Event Sources -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module includes classes that allow using various AWS services as event sources for AWS Lambda via the high-level `lambda.addEventSource(source)` API. diff --git a/packages/@aws-cdk/aws-lambda/README.md b/packages/@aws-cdk/aws-lambda/README.md index 8a02e3009952b..7a4ee26253432 100644 --- a/packages/@aws-cdk/aws-lambda/README.md +++ b/packages/@aws-cdk/aws-lambda/README.md @@ -1,11 +1,16 @@ ## AWS Lambda Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This construct library allows you to define AWS Lambda Functions. diff --git a/packages/@aws-cdk/aws-logs-destinations/README.md b/packages/@aws-cdk/aws-logs-destinations/README.md index 165ac001dd035..f5558acf037f0 100644 --- a/packages/@aws-cdk/aws-logs-destinations/README.md +++ b/packages/@aws-cdk/aws-logs-destinations/README.md @@ -1,10 +1,15 @@ # CDK Construct Libray for AWS XXX -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + A short description here. diff --git a/packages/@aws-cdk/aws-logs/README.md b/packages/@aws-cdk/aws-logs/README.md index fd079149a37b9..5c3117b5c24ac 100644 --- a/packages/@aws-cdk/aws-logs/README.md +++ b/packages/@aws-cdk/aws-logs/README.md @@ -1,11 +1,16 @@ ## Amazon CloudWatch Logs Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This library supplies constructs for working with CloudWatch Logs. diff --git a/packages/@aws-cdk/aws-mediastore/README.md b/packages/@aws-cdk/aws-mediastore/README.md index 4205549ecba0b..3dc0931076911 100644 --- a/packages/@aws-cdk/aws-mediastore/README.md +++ b/packages/@aws-cdk/aws-mediastore/README.md @@ -1,11 +1,16 @@ ## AWS Elemental MediaStore Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-neptune/README.md b/packages/@aws-cdk/aws-neptune/README.md index c7f5ae3db7905..e343cb6134ff8 100644 --- a/packages/@aws-cdk/aws-neptune/README.md +++ b/packages/@aws-cdk/aws-neptune/README.md @@ -1,11 +1,16 @@ ## Amazon Neptune Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts const neptune = require('@aws-cdk/aws-neptune'); diff --git a/packages/@aws-cdk/aws-opsworks/README.md b/packages/@aws-cdk/aws-opsworks/README.md index 103c3af08a5b6..6e6a6edb4ae12 100644 --- a/packages/@aws-cdk/aws-opsworks/README.md +++ b/packages/@aws-cdk/aws-opsworks/README.md @@ -1,9 +1,15 @@ ## AWS OpsWorks Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-opsworkscm/README.md b/packages/@aws-cdk/aws-opsworkscm/README.md index 881a5006ea41c..75d996a61965b 100644 --- a/packages/@aws-cdk/aws-opsworkscm/README.md +++ b/packages/@aws-cdk/aws-opsworkscm/README.md @@ -1,11 +1,16 @@ ## AWS OpsWorks CM Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-pinpointemail/README.md b/packages/@aws-cdk/aws-pinpointemail/README.md index 77855116cb8c7..6f9caac726f0d 100644 --- a/packages/@aws-cdk/aws-pinpointemail/README.md +++ b/packages/@aws-cdk/aws-pinpointemail/README.md @@ -1,11 +1,16 @@ ## Amazon Pinpoint Email Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-quickstarts/README.md b/packages/@aws-cdk/aws-quickstarts/README.md index ab14ca77c44c1..e187015a4fd51 100644 --- a/packages/@aws-cdk/aws-quickstarts/README.md +++ b/packages/@aws-cdk/aws-quickstarts/README.md @@ -1,9 +1,14 @@ ## AWS Quickstarts for the CDK -
- Stability: 0 - Deprecated. This API may emit warnings. Backward compatibility is not guaranteed. -
+ +--- + +![Stability: Deprecated](https://img.shields.io/badge/stability-Deprecated-critical.svg?style=for-the-badge) + +> This API may emit warnings. Backward compatibility is not guaranteed. + +--- + This module has been deprecated. Use `@aws-cdk/aws-cloudformation.CfnStack` instead. diff --git a/packages/@aws-cdk/aws-ram/README.md b/packages/@aws-cdk/aws-ram/README.md index e8dfa9c3a235a..3783579076056 100644 --- a/packages/@aws-cdk/aws-ram/README.md +++ b/packages/@aws-cdk/aws-ram/README.md @@ -1,11 +1,16 @@ ## AWS Resource Access Manager Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-rds/README.md b/packages/@aws-cdk/aws-rds/README.md index 7a1860dc0e97e..002bbab102c76 100644 --- a/packages/@aws-cdk/aws-rds/README.md +++ b/packages/@aws-cdk/aws-rds/README.md @@ -1,11 +1,16 @@ ## Amazon Relational Database Service Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ### Starting a Clustered Database diff --git a/packages/@aws-cdk/aws-redshift/README.md b/packages/@aws-cdk/aws-redshift/README.md index ae61de1562f2b..57744078371f9 100644 --- a/packages/@aws-cdk/aws-redshift/README.md +++ b/packages/@aws-cdk/aws-redshift/README.md @@ -1,9 +1,15 @@ ## Amazon Redshift Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-robomaker/README.md b/packages/@aws-cdk/aws-robomaker/README.md index b969e29d8851f..241797e9b6b30 100644 --- a/packages/@aws-cdk/aws-robomaker/README.md +++ b/packages/@aws-cdk/aws-robomaker/README.md @@ -1,11 +1,16 @@ ## AWS RoboMaker Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-route53-targets/README.md b/packages/@aws-cdk/aws-route53-targets/README.md index 152d7167d412c..75e9f7accb857 100644 --- a/packages/@aws-cdk/aws-route53-targets/README.md +++ b/packages/@aws-cdk/aws-route53-targets/README.md @@ -1,11 +1,16 @@ # Route53 Alias Record Targets for the CDK Route53 Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This library contains Route53 Alias Record targets, for an ELBv2 load balancer and for a CloudFront distribution. diff --git a/packages/@aws-cdk/aws-route53/README.md b/packages/@aws-cdk/aws-route53/README.md index b0a6c01d4911b..6386a11f14be6 100644 --- a/packages/@aws-cdk/aws-route53/README.md +++ b/packages/@aws-cdk/aws-route53/README.md @@ -1,11 +1,16 @@ ## Amazon Route53 Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + To add a public hosted zone: diff --git a/packages/@aws-cdk/aws-route53resolver/README.md b/packages/@aws-cdk/aws-route53resolver/README.md index c456c9c929efd..6e687fa5782ef 100644 --- a/packages/@aws-cdk/aws-route53resolver/README.md +++ b/packages/@aws-cdk/aws-route53resolver/README.md @@ -1,11 +1,16 @@ ## Amazon Route53 Resolver Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts const route53resolver = require('@aws-cdk/aws-route53resolver'); diff --git a/packages/@aws-cdk/aws-s3-deployment/README.md b/packages/@aws-cdk/aws-s3-deployment/README.md index c63c1123a8d1b..3e4bc8d27e052 100644 --- a/packages/@aws-cdk/aws-s3-deployment/README.md +++ b/packages/@aws-cdk/aws-s3-deployment/README.md @@ -1,11 +1,16 @@ ## AWS S3 Deployment Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + > __Status: Experimental__ diff --git a/packages/@aws-cdk/aws-s3-notifications/README.md b/packages/@aws-cdk/aws-s3-notifications/README.md index 01fe8dd9febb5..6a400669dbae2 100644 --- a/packages/@aws-cdk/aws-s3-notifications/README.md +++ b/packages/@aws-cdk/aws-s3-notifications/README.md @@ -1,11 +1,16 @@ ## S3 Bucket Notifications Destinations -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module includes integration classes for using Topics, Queues or Lambdas as S3 Notification Destinations. \ No newline at end of file diff --git a/packages/@aws-cdk/aws-s3/README.md b/packages/@aws-cdk/aws-s3/README.md index f5dcb80d0b83f..60d92601ef161 100644 --- a/packages/@aws-cdk/aws-s3/README.md +++ b/packages/@aws-cdk/aws-s3/README.md @@ -1,11 +1,16 @@ ## Amazon S3 Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Define an unencrypted S3 bucket. diff --git a/packages/@aws-cdk/aws-sagemaker/README.md b/packages/@aws-cdk/aws-sagemaker/README.md index 1e9ab66dd376c..0fc5689a70b7d 100644 --- a/packages/@aws-cdk/aws-sagemaker/README.md +++ b/packages/@aws-cdk/aws-sagemaker/README.md @@ -1,11 +1,16 @@ ## Amazon SageMaker Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts const sagemaker = require('@aws-cdk/aws-sagemaker'); diff --git a/packages/@aws-cdk/aws-sam/README.md b/packages/@aws-cdk/aws-sam/README.md index 5d737fd81e8ab..73bb668bbda5d 100644 --- a/packages/@aws-cdk/aws-sam/README.md +++ b/packages/@aws-cdk/aws-sam/README.md @@ -1,11 +1,16 @@ ## AWS Serverless Application Model Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module includes low-level constructs that synthesize into `AWS::Serverless` resources. diff --git a/packages/@aws-cdk/aws-sdb/README.md b/packages/@aws-cdk/aws-sdb/README.md index 1110baa94a51a..5d415998b42b4 100644 --- a/packages/@aws-cdk/aws-sdb/README.md +++ b/packages/@aws-cdk/aws-sdb/README.md @@ -1,9 +1,15 @@ ## Amazon SimpleDB Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-secretsmanager/README.md b/packages/@aws-cdk/aws-secretsmanager/README.md index e49a5e6c629aa..ed3f00b91d1d2 100644 --- a/packages/@aws-cdk/aws-secretsmanager/README.md +++ b/packages/@aws-cdk/aws-secretsmanager/README.md @@ -1,11 +1,16 @@ ## AWS Secrets Manager Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ```ts const secretsmanager = require('@aws-cdk/aws-secretsmanager'); diff --git a/packages/@aws-cdk/aws-servicecatalog/README.md b/packages/@aws-cdk/aws-servicecatalog/README.md index af9568b241adf..0a7ce6eb4e666 100644 --- a/packages/@aws-cdk/aws-servicecatalog/README.md +++ b/packages/@aws-cdk/aws-servicecatalog/README.md @@ -1,9 +1,15 @@ ## AWS Service Catalog Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-servicediscovery/README.md b/packages/@aws-cdk/aws-servicediscovery/README.md index c696551dc4bb7..496e72d1cef68 100644 --- a/packages/@aws-cdk/aws-servicediscovery/README.md +++ b/packages/@aws-cdk/aws-servicediscovery/README.md @@ -1,10 +1,16 @@ ## Amazon ECS Service Discovery Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-ses/README.md b/packages/@aws-cdk/aws-ses/README.md index 41f333c522cc5..bf25dc22da74a 100644 --- a/packages/@aws-cdk/aws-ses/README.md +++ b/packages/@aws-cdk/aws-ses/README.md @@ -1,10 +1,16 @@ ## Amazon Simple Email Service Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-sns/README.md b/packages/@aws-cdk/aws-sns/README.md index befdc9ba98665..9b1270f84fbc3 100644 --- a/packages/@aws-cdk/aws-sns/README.md +++ b/packages/@aws-cdk/aws-sns/README.md @@ -1,11 +1,16 @@ ## Amazon Simple Notification Service Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Add an SNS Topic to your stack: diff --git a/packages/@aws-cdk/aws-sqs/README.md b/packages/@aws-cdk/aws-sqs/README.md index cd97d4545a15c..794dc99b6425a 100644 --- a/packages/@aws-cdk/aws-sqs/README.md +++ b/packages/@aws-cdk/aws-sqs/README.md @@ -1,11 +1,16 @@ ## Amazon Simple Queue Service Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + Amazon Simple Queue Service (SQS) is a fully managed message queuing service that enables you to decouple and scale microservices, distributed systems, and serverless diff --git a/packages/@aws-cdk/aws-ssm/README.md b/packages/@aws-cdk/aws-ssm/README.md index aa665b4464f2f..b413673a337ce 100644 --- a/packages/@aws-cdk/aws-ssm/README.md +++ b/packages/@aws-cdk/aws-ssm/README.md @@ -1,10 +1,16 @@ ## AWS Systems Manager Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-stepfunctions-tasks/README.md b/packages/@aws-cdk/aws-stepfunctions-tasks/README.md index 840f49e38e17b..faa03c8752899 100644 --- a/packages/@aws-cdk/aws-stepfunctions-tasks/README.md +++ b/packages/@aws-cdk/aws-stepfunctions-tasks/README.md @@ -1,10 +1,15 @@ # Tasks for AWS CloudWatch StepFunctions -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + See the README of the `@aws-cdk/aws-stepfunctions` library. diff --git a/packages/@aws-cdk/aws-stepfunctions/README.md b/packages/@aws-cdk/aws-stepfunctions/README.md index d501505b7c098..0bb4278c64659 100644 --- a/packages/@aws-cdk/aws-stepfunctions/README.md +++ b/packages/@aws-cdk/aws-stepfunctions/README.md @@ -1,11 +1,16 @@ ## AWS Step Functions Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + The `@aws-cdk/aws-stepfunctions` package contains constructs for building serverless workflows using objects. Use this in conjunction with the diff --git a/packages/@aws-cdk/aws-transfer/README.md b/packages/@aws-cdk/aws-transfer/README.md index fde98f8d7d884..d5cdcbb431f9a 100644 --- a/packages/@aws-cdk/aws-transfer/README.md +++ b/packages/@aws-cdk/aws-transfer/README.md @@ -1,11 +1,16 @@ ## AWS Transfer for SFTP Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-waf/README.md b/packages/@aws-cdk/aws-waf/README.md index c73004a57d9d6..06ed68155ebbe 100644 --- a/packages/@aws-cdk/aws-waf/README.md +++ b/packages/@aws-cdk/aws-waf/README.md @@ -1,9 +1,15 @@ ## AWS Web Application Firewall Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-wafregional/README.md b/packages/@aws-cdk/aws-wafregional/README.md index 32b1b218111f4..3d335cbe5481c 100644 --- a/packages/@aws-cdk/aws-wafregional/README.md +++ b/packages/@aws-cdk/aws-wafregional/README.md @@ -1,9 +1,15 @@ ## AWS WAF Regional Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/aws-workspaces/README.md b/packages/@aws-cdk/aws-workspaces/README.md index 472cdf00891c4..9093056c55bf3 100644 --- a/packages/@aws-cdk/aws-workspaces/README.md +++ b/packages/@aws-cdk/aws-workspaces/README.md @@ -1,9 +1,15 @@ ## Amazon WorkSpaces Construct Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/cdk/README.md b/packages/@aws-cdk/cdk/README.md index 8467a94bee7a5..e5c14a5361134 100644 --- a/packages/@aws-cdk/cdk/README.md +++ b/packages/@aws-cdk/cdk/README.md @@ -1,11 +1,16 @@ ## AWS Cloud Development Kit Core Library -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This library includes the basic building blocks of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) (AWS CDK). diff --git a/packages/@aws-cdk/cloudformation-diff/README.md b/packages/@aws-cdk/cloudformation-diff/README.md index 59bb3bcaff782..c385bf37dc631 100644 --- a/packages/@aws-cdk/cloudformation-diff/README.md +++ b/packages/@aws-cdk/cloudformation-diff/README.md @@ -1,9 +1,15 @@ ## Utilities to diff AWS CDK stacks against CloudFormation templates -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/cx-api/README.md b/packages/@aws-cdk/cx-api/README.md index 94cf2b410ac99..19b7d13c72e2b 100644 --- a/packages/@aws-cdk/cx-api/README.md +++ b/packages/@aws-cdk/cx-api/README.md @@ -1,9 +1,15 @@ ## Cloud Executable protocol -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. diff --git a/packages/@aws-cdk/region-info/README.md b/packages/@aws-cdk/region-info/README.md index afc48812c062d..d42d9532f84fa 100644 --- a/packages/@aws-cdk/region-info/README.md +++ b/packages/@aws-cdk/region-info/README.md @@ -1,10 +1,16 @@ # AWS Region-Specific Information Directory -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + ## Usage Some information used in CDK Applications differs from one AWS region to diff --git a/packages/@aws-cdk/runtime-values/README.md b/packages/@aws-cdk/runtime-values/README.md index 2b20496d3b815..241862f1733a0 100644 --- a/packages/@aws-cdk/runtime-values/README.md +++ b/packages/@aws-cdk/runtime-values/README.md @@ -1,9 +1,14 @@ ## Runtime Values -
- Stability: 0 - Deprecated. This API may emit warnings. Backward compatibility is not guaranteed. -
+ +--- + +![Stability: Deprecated](https://img.shields.io/badge/stability-Deprecated-critical.svg?style=for-the-badge) + +> This API may emit warnings. Backward compatibility is not guaranteed. + +--- + This module has been deprecated. Use environment variables or SSM parameters to publish values to runtime code. diff --git a/packages/aws-cdk/README.md b/packages/aws-cdk/README.md index 775687fb2306d..7d64101df271c 100644 --- a/packages/aws-cdk/README.md +++ b/packages/aws-cdk/README.md @@ -1,10 +1,16 @@ ## AWS CDK Toolkit -
- Stability: 1 - Experimental. This API is still under active development and subject to non-backward - compatible changes or removal in any future version. Use of the API is not recommended in production - environments. Experimental APIs are not subject to the Semantic Versioning model. -
+ + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +> This API is still under active development and subject to non-backward +> compatible changes or removal in any future version. Use of the API is not recommended in production +> environments. Experimental APIs are not subject to the Semantic Versioning model. + +--- + The AWS CDK Toolkit provides the `cdk` command-line interface that can be used to work with AWS CDK applications. diff --git a/packages/simple-resource-bundler/README.md b/packages/simple-resource-bundler/README.md index eb8410e070513..53443fc936829 100644 --- a/packages/simple-resource-bundler/README.md +++ b/packages/simple-resource-bundler/README.md @@ -1,9 +1,14 @@ # simple-resource-bundler -
- Stability: 0 - Deprecated. This API may emit warnings. Backward compatibility is not guaranteed. -
+ +--- + +![Stability: Deprecated](https://img.shields.io/badge/stability-Deprecated-critical.svg?style=for-the-badge) + +> This API may emit warnings. Backward compatibility is not guaranteed. + +--- + This tool has been deprecated. Use @aws-cdk/assets instead. diff --git a/tools/pkglint/lib/rules.ts b/tools/pkglint/lib/rules.ts index badf5471181ee..66da2a5f75ff3 100644 --- a/tools/pkglint/lib/rules.ts +++ b/tools/pkglint/lib/rules.ts @@ -213,7 +213,7 @@ export class StabilitySetting extends ValidationRule { const badgeRegex = new RegExp(badge.replace(/[.*+?^${}()|[\]\\]/g, '\\$&').replace(/\w+/g, '\\w+')); if (!badgeRegex.test(readmeContent)) { // Removing a possible old, now invalid stability indication from the README.md before adding a new one - const [title, ...body] = readmeContent.replace(/
\n/m, '').split('\n'); + const [title, ...body] = readmeContent.replace(/(?:.|\n)+\n+/m, '').split('\n'); pkg.report({ ruleName: this.name, message: `Missing stability banner for ${stability} in README.md file`, @@ -226,32 +226,38 @@ export class StabilitySetting extends ValidationRule { switch (stability) { case 'deprecated': return _div( - '#D60027', - 'Stability: 0 - Deprecated. This API may emit warnings. Backward compatibility is not guaranteed.', + { label: 'Deprecated', color: 'critical' }, + 'This API may emit warnings. Backward compatibility is not guaranteed.', ); case 'experimental': return _div( - '#EC5315', - 'Stability: 1 - Experimental. This API is still under active development and subject to non-backward', + { label: 'Experimental', color: 'important' }, + 'This API is still under active development and subject to non-backward', 'compatible changes or removal in any future version. Use of the API is not recommended in production', 'environments. Experimental APIs are not subject to the Semantic Versioning model.', ); case 'stable': return _div( - '#4EBA0F', - 'Stability: 2 - Stable. This API is subject to the Semantic Versioning model. It will not be subject to', + { label: 'Stable', color: 'success' }, + 'This API is subject to the Semantic Versioning model. It will not be subject to', 'non-backward compatible changes or removal in a subsequent patch or feature release.' ); default: return undefined; } - function _div(color: string, ...messages: string[]) { + function _div(badge: { label: string, color: string }, ...messages: string[]) { return [ - '
`, - ...messages.map(message => ` ${message}`), - '
', + '', + '', + '---', + '', + `![Stability: ${badge.label}](https://img.shields.io/badge/stability-${badge.label}-${badge.color}.svg?style=for-the-badge)`, + '', + ...messages.map(message => `> ${message}`), + '', + '---', + '', '', ].join('\n'); }