Merge branch 'master' into njlynch/dnscert-opt-cleanup

CONTRIBUTING.md

@@ -46,7 +46,7 @@ let us know if it's not up-to-date (even better, submit a PR with your  correcti
 
 The following steps describe how to set up the AWS CDK repository on your local machine.
 The alternative is to use [Gitpod](https://www.gitpod.io/), a Cloud IDE for your development.
-See [Gitpod section](#gitpod) on how to set up the CDK repo on Gitpod.
+See [Gitpod section](#gitpod-alternative) on how to set up the CDK repo on Gitpod.
 
 ### Setup
 
@@ -69,7 +69,7 @@ $ yarn install
 ```
 
 We recommend that you use [Visual Studio Code](https://code.visualstudio.com/) to work on the CDK.
-We use `eslint` to keep our code consistent in terms of style and reducing defects. We recommend installing the
+We use `eslint` to keep our code consistent in terms of style and reducing defects. We recommend installing
 the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) as well.
 
 ### Repo Layout
@@ -726,7 +726,7 @@ these directories.
 ### Linking against this repository
 
 If you are developing your own CDK application or library and want to use the locally checked out version of the
-AWS CDK, instead of the the version of npm, the `./link-all.sh` script will help here.
+AWS CDK, instead of the version of npm, the `./link-all.sh` script will help here.
 
 This script symlinks the built modules from the local AWS CDK repo under the `node_modules/` folder of the CDK app or
 library.
@@ -803,35 +803,17 @@ The pattern is simple:
    with the name of the context key that **enables** this new feature (for
    example, `ENABLE_STACK_NAME_DUPLICATES`). The context key should be in the
    form `module.Type:feature` (e.g. `@aws-cdk/core:enableStackNameDuplicates`).
-2. Use `node.tryGetContext(cxapi.ENABLE_XXX)` to check if this feature is enabled
+2. Use `FeatureFlags.of(construct).isEnabled(cxapi.ENABLE_XXX)` to check if this feature is enabled
    in your code. If it is not defined, revert to the legacy behavior.
 3. Add your feature flag to the `FUTURE_FLAGS` map in
    [cx-api/lib/features.ts](https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/cx-api/lib/features.ts).
    This map is inserted to generated `cdk.json` files for new projects created
    through `cdk init`.
-4. In your PR title (which goes into CHANGELOG), add a `(under feature flag)` suffix. e.g:
+4. In your tests, use the `testFutureBehavior` and `testLegacyBehavior` [jest helper methods] to test the enabled and disabled behavior.
+5. In your PR title (which goes into CHANGELOG), add a `(under feature flag)` suffix. e.g:
 
     `fix(core): impossible to use the same physical stack name for two stacks (under feature flag)`
 
-In the [next major version of the
-CDK](https://github.com/aws/aws-cdk/issues/3398) we will either remove the
-legacy behavior or flip the logic for all these features and then
-reset the `FEATURE_FLAGS` map for the next cycle.
-
-### Feature Flags - CDKv2
-
-We have started working on the next version of the CDK, specifically CDKv2. This is currently being maintained
-on a separate branch `v2-main` whereas `master` continues to track versions `1.x`.
-
-Feature flags introduced in the CDK 1.x and removed in 2.x, must be added to the `FUTURE_FLAGS_EXPIRED` list in
-[cx-api/lib/features.ts](https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/cx-api/lib/features.ts)
-on the `v2-main` branch.
-This will make the default behaviour in CDKv2 as if the flag is enabled and also prevents users from disabling
-the feature flag.
-
-A couple of [jest helper methods] are available for use with unit tests. These help run unit tests that test
-behaviour when flags are enabled or disabled in the two major versions.
-
 [jest helper methods]: https://github.com/aws/aws-cdk/blob/master/tools/@aws-cdk/cdk-build-tools/lib/feature-flag.ts
 
 ## Versioning and Release

README.md

@@ -153,6 +153,12 @@ this capability, please see the
 ## More Resources
 * [CDK Workshop](https://cdkworkshop.com/)
 * [Construct Hub](https://constructs.dev) - Find and use open-source Cloud Development Kit (CDK) libraries
+* Best Practices
+  * [Best practices for developing cloud applications with AWS CDK](https://aws.amazon.com/blogs/devops/best-practices-for-developing-cloud-applications-with-aws-cdk/)
+  * [Align with best practices while creating infrastructure using cdk aspects](https://aws.amazon.com/blogs/devops/align-with-best-practices-while-creating-infrastructure-using-cdk-aspects/)
+  * [Recommended AWS CDK project structure for Python applications](https://aws.amazon.com/blogs/developer/recommended-aws-cdk-project-structure-for-python-applications/)
+  * [Best practices for discoverability of a construct library on Construct Hub](https://aws.amazon.com/blogs/opensource/best-practices-for-discoverability-of-a-construct-library-on-construct-hub/)
+* [All developer blog posts about AWS CDK](https://aws.amazon.com/blogs/developer/category/developer-tools/aws-cloud-development-kit/)
 * **[CDK Construction Zone](https://www.twitch.tv/collections/9kCOGphNZBYVdA)** - A Twitch live coding series hosted by the CDK team, season one episodes:
   * Triggers: Join us as we implement [Triggers](https://github.com/aws/aws-cdk-rfcs/issues/71), a Construct for configuring deploy time actions. Episodes 1-3:
     * [S1E1](https://www.twitch.tv/videos/917691798): Triggers (part 1); **Participants:** @NetaNir, @eladb, @richardhboyd

allowed-breaking-changes.txt

@@ -93,3 +93,36 @@ incompatible-argument:@aws-cdk/aws-autoscaling-hooktargets.FunctionHook.bind
 incompatible-argument:@aws-cdk/aws-autoscaling-hooktargets.QueueHook.bind
 incompatible-argument:@aws-cdk/aws-autoscaling-hooktargets.TopicHook.bind
 incompatible-argument:@aws-cdk/aws-autoscaling.ILifecycleHookTarget.bind
+
+# removed properties from kafka eventsources as they are not supported
+removed:@aws-cdk/aws-lambda-event-sources.KafkaEventSourceProps.bisectBatchOnError
+removed:@aws-cdk/aws-lambda-event-sources.KafkaEventSourceProps.maxRecordAge
+removed:@aws-cdk/aws-lambda-event-sources.KafkaEventSourceProps.parallelizationFactor
+removed:@aws-cdk/aws-lambda-event-sources.KafkaEventSourceProps.reportBatchItemFailures
+removed:@aws-cdk/aws-lambda-event-sources.KafkaEventSourceProps.retryAttempts
+removed:@aws-cdk/aws-lambda-event-sources.KafkaEventSourceProps.tumblingWindow
+removed:@aws-cdk/aws-lambda-event-sources.ManagedKafkaEventSourceProps.bisectBatchOnError
+removed:@aws-cdk/aws-lambda-event-sources.ManagedKafkaEventSourceProps.maxRecordAge
+removed:@aws-cdk/aws-lambda-event-sources.ManagedKafkaEventSourceProps.parallelizationFactor
+removed:@aws-cdk/aws-lambda-event-sources.ManagedKafkaEventSourceProps.reportBatchItemFailures
+removed:@aws-cdk/aws-lambda-event-sources.ManagedKafkaEventSourceProps.retryAttempts
+removed:@aws-cdk/aws-lambda-event-sources.ManagedKafkaEventSourceProps.tumblingWindow 
+removed:@aws-cdk/aws-lambda-event-sources.SelfManagedKafkaEventSourceProps.bisectBatchOnError
+removed:@aws-cdk/aws-lambda-event-sources.SelfManagedKafkaEventSourceProps.maxRecordAge
+removed:@aws-cdk/aws-lambda-event-sources.SelfManagedKafkaEventSourceProps.parallelizationFactor
+removed:@aws-cdk/aws-lambda-event-sources.SelfManagedKafkaEventSourceProps.reportBatchItemFailures
+removed:@aws-cdk/aws-lambda-event-sources.SelfManagedKafkaEventSourceProps.retryAttempts
+removed:@aws-cdk/aws-lambda-event-sources.SelfManagedKafkaEventSourceProps.tumblingWindow
+base-types:@aws-cdk/aws-lambda-event-sources.KafkaEventSourceProps
+base-types:@aws-cdk/aws-lambda-event-sources.ManagedKafkaEventSourceProps
+base-types:@aws-cdk/aws-lambda-event-sources.SelfManagedKafkaEventSourceProps
+
+# fixed vpc property of BaseLoadBalancer so it correctly implements I(Application|Network)LoadBalancer (i.e: must be optional)
+changed-type:@aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer.vpc
+changed-type:@aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer.vpc
+changed-type:@aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancer.vpc
+
+# removed methods and properties related to event bridge notifications for S3 buckets as they are not yet supported (19 Jan 2022)
+removed:@aws-cdk/aws-s3.Bucket.enableEventBridgeNotification
+removed:@aws-cdk/aws-s3.BucketBase.enableEventBridgeNotification
+removed:@aws-cdk/aws-s3.BucketProps.eventBridgeEnabled

buildspec.yaml

@@ -27,6 +27,8 @@ phases:
       - /bin/bash ./scripts/transform.sh
   post_build:
     commands:
+      # Short-circuit: Don't run pack if the above build failed.
+      - '[ ${CODEBUILD_BUILD_SUCCEEDING:-0} -eq 1 ] || exit 1'
       - "[ -f .BUILD_COMPLETED ] && /bin/bash ./pack.sh"
       - /bin/bash ./scripts/cache-store.sh
 artifacts:

package.json

@@ -16,21 +16,22 @@
   },
   "devDependencies": {
     "@yarnpkg/lockfile": "^1.1.0",
-    "cdk-generate-synthetic-examples": "^0.1.1",
+    "cdk-generate-synthetic-examples": "^0.1.3",
     "conventional-changelog-cli": "^2.2.2",
     "fs-extra": "^9.1.0",
-    "graceful-fs": "^4.2.8",
+    "graceful-fs": "^4.2.9",
     "jest-junit": "^13.0.0",
-    "jsii-diff": "^1.50.0",
-    "jsii-pacmak": "^1.50.0",
-    "jsii-reflect": "^1.50.0",
-    "jsii-rosetta": "^1.50.0",
+    "jsii-diff": "^1.52.1",
+    "jsii-pacmak": "^1.52.1",
+    "jsii-reflect": "^1.52.1",
+    "jsii-rosetta": "^1.52.1",
     "lerna": "^4.0.0",
     "patch-package": "^6.4.7",
     "standard-version": "^9.3.2",
     "typescript": "~3.9.10"
   },
   "resolutions": {
+    "colors": "1.4.0",
     "string-width": "^4.2.3"
   },
   "repository": {
@@ -122,8 +123,8 @@
       "aws-cdk-lib/@balena/dockerignore/**",
       "aws-cdk-lib/case",
       "aws-cdk-lib/case/**",
-      "aws-cdk-lib/colors",
-      "aws-cdk-lib/colors/**",
+      "aws-cdk-lib/chalk",
+      "aws-cdk-lib/chalk/**",
       "aws-cdk-lib/diff",
       "aws-cdk-lib/diff/**",
       "aws-cdk-lib/fast-deep-equal",
@@ -150,8 +151,8 @@
       "monocdk/@balena/dockerignore/**",
       "monocdk/case",
       "monocdk/case/**",
-      "monocdk/colors",
-      "monocdk/colors/**",
+      "monocdk/chalk",
+      "monocdk/chalk/**",
       "monocdk/diff",
       "monocdk/diff/**",
       "monocdk/fast-deep-equal",

packages/@aws-cdk-containers/ecs-service-extensions/README.md

@@ -109,7 +109,43 @@ nameDescription.add(new Container({
 Every `ServiceDescription` requires at minimum that you add a `Container` extension
 which defines the main application (essential) container to run for the service.
 
-After that, you can optionally enable additional features for the service using the `ServiceDescription.add()` method:
+### Logging using `awslogs` log driver
+
+If no observability extensions have been configured for a service, the ECS Service Extensions configures an `awslogs` log driver for the application container of the service to send the container logs to CloudWatch Logs.
+
+You can either provide a log group to the `Container` extension or one will be created for you by the CDK.
+
+Following is an example of an application with an `awslogs` log driver configured for the application container:
+
+```ts
+const environment = new Environment(stack, 'production');
+
+const nameDescription = new ServiceDescription();
+nameDescription.add(new Container({
+  cpu: 1024,
+  memoryMiB: 2048,
+  trafficPort: 80,
+  image: ContainerImage.fromRegistry('nathanpeck/name'),
+  environment: {
+    PORT: '80',
+  },
+  logGroup: new awslogs.LogGroup(stack, 'MyLogGroup'),
+}));
+```
+
+If a log group is not provided, no observability extensions have been created, and the `ECS_SERVICE_EXTENSIONS_ENABLE_DEFAULT_LOG_DRIVER` feature flag is enabled, then logging will be configured by default and a log group will be created for you.
+
+The `ECS_SERVICE_EXTENSIONS_ENABLE_DEFAULT_LOG_DRIVER` feature flag is enabled by default in any CDK apps that are created with CDK v1.140.0 or v2.8.0 and later.
+
+To enable default logging for previous versions, ensure that the `ECS_SERVICE_EXTENSIONS_ENABLE_DEFAULT_LOG_DRIVER` flag within the application stack context is set to true, like so:
+
+```ts
+stack.node.setContext(cxapi.ECS_SERVICE_EXTENSIONS_ENABLE_DEFAULT_LOG_DRIVER, true);
+```
+
+Alternatively, you can also set the feature flag in the `cdk.json` file. For more information, refer the [docs](https://docs.aws.amazon.com/cdk/v2/guide/featureflags.html).  
+
+After adding the `Container` extension, you can optionally enable additional features for the service using the `ServiceDescription.add()` method:
 
 ```ts
 nameDescription.add(new AppMeshExtension({ mesh }));

packages/@aws-cdk-containers/ecs-service-extensions/lib/extensions/container.ts

@@ -1,4 +1,7 @@
 import * as ecs from '@aws-cdk/aws-ecs';
+import * as awslogs from '@aws-cdk/aws-logs';
+import * as cdk from '@aws-cdk/core';
+import * as cxapi from '@aws-cdk/cx-api';
 import { Service } from '../service';
 import { ServiceExtension } from './extension-interfaces';
 
@@ -38,6 +41,13 @@ export interface ContainerExtensionProps {
   readonly environment?: {
     [key: string]: string,
   }
+
+  /**
+   * The log group into which application container logs should be routed.
+   *
+   * @default - A log group is automatically created for you if the `ECS_SERVICE_EXTENSIONS_ENABLE_DEFAULT_LOG_DRIVER` feature flag is set.
+   */
+  readonly logGroup?: awslogs.ILogGroup;
 }
 
 /**
@@ -51,6 +61,11 @@ export class Container extends ServiceExtension {
    */
   public readonly trafficPort: number;
 
+  /**
+   * The log group into which application container logs should be routed.
+   */
+  public logGroup?: awslogs.ILogGroup;
+
   /**
    * The settings for the container.
    */
@@ -60,11 +75,12 @@ export class Container extends ServiceExtension {
     super('service-container');
     this.props = props;
     this.trafficPort = props.trafficPort;
+    this.logGroup = props.logGroup;
   }
 
-  // @ts-ignore - Ignore unused params that are required for abstract class extend
   public prehook(service: Service, scope: Construct) {
     this.parentService = service;
+    this.scope = scope;
   }
 
   // This hook sets the overall task resource requirements to the
@@ -93,6 +109,31 @@ export class Container extends ServiceExtension {
       containerProps = hookProvider.mutateContainerDefinition(containerProps);
     });
 
+    // If no observability extensions have been added to the service description then we can configure the `awslogs` log driver
+    if (!containerProps.logging) {
+      // Create a log group for the service if one is not provided by the user (only if feature flag is set)
+      if (!this.logGroup && this.parentService.node.tryGetContext(cxapi.ECS_SERVICE_EXTENSIONS_ENABLE_DEFAULT_LOG_DRIVER)) {
+        this.logGroup = new awslogs.LogGroup(this.scope, `${this.parentService.id}-logs`, {
+          logGroupName: `${this.parentService.id}-logs`,
+          removalPolicy: cdk.RemovalPolicy.DESTROY,
+          retention: awslogs.RetentionDays.ONE_MONTH,
+        });
+      }
+
+      if (this.logGroup) {
+        containerProps = {
+          ...containerProps,
+          logging: new ecs.AwsLogDriver({
+            streamPrefix: this.parentService.id,
+            logGroup: this.logGroup,
+          }),
+        };
+      }
+    } else {
+      if (this.logGroup) {
+        throw Error(`Log configuration already specified. You cannot provide a log group for the application container of service '${this.parentService.id}' while also adding log configuration separately using service extensions.`);
+      }
+    }
     this.container = taskDefinition.addContainer('app', containerProps);
 
     // Create a port mapping for the container

packages/@aws-cdk-containers/ecs-service-extensions/lib/extensions/scale-on-cpu-utilization.ts

@@ -2,8 +2,13 @@ import * as ecs from '@aws-cdk/aws-ecs';
 import * as cdk from '@aws-cdk/core';
 import { ServiceExtension, ServiceBuild } from './extension-interfaces';
 
+
 /**
  * The autoscaling settings.
+ *
+ * @deprecated use the `minTaskCount` and `maxTaskCount` properties of `autoScaleTaskCount` in the `Service` construct
+ * to configure the auto scaling target for the service. For more information, please refer
+ * https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling .
  */
 export interface CpuScalingProps {
   /**
@@ -61,6 +66,9 @@ const cpuScalingPropsDefault = {
 
 /**
  * This extension helps you scale your service according to CPU utilization.
+ *
+ * @deprecated To enable target tracking based on CPU utilization, use the `targetCpuUtilization` property of `autoScaleTaskCount` in the `Service` construct.
+ * For more information, please refer https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling .
  */
 export class ScaleOnCpuUtilization extends ServiceExtension {
   /**
@@ -126,6 +134,9 @@ export class ScaleOnCpuUtilization extends ServiceExtension {
   // This hook utilizes the resulting service construct
   // once it is created.
   public useService(service: ecs.Ec2Service | ecs.FargateService) {
+    if (this.parentService.scalableTaskCount) {
+      throw Error('Cannot specify \'autoScaleTaskCount\' in the Service construct and also provide a  \'ScaleOnCpuUtilization\' extension. \'ScaleOnCpuUtilization\' is deprecated. Please only provide \'autoScaleTaskCount\'.');
+    }
     const scalingTarget = service.autoScaleTaskCount({
       minCapacity: this.minTaskCount,
       maxCapacity: this.maxTaskCount,
@@ -136,5 +147,6 @@ export class ScaleOnCpuUtilization extends ServiceExtension {
       scaleInCooldown: this.scaleInCooldown,
       scaleOutCooldown: this.scaleOutCooldown,
     });
+    this.parentService.enableAutoScalingPolicy();
   }
 }