docs: add comment above both examples

aws · Feb 25, 2021 · 0940dc4 · 0940dc4
1 parent fd39858
commit 0940dc4
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/packages/@aws-cdk/aws-ecs/README.md b/packages/@aws-cdk/aws-ecs/README.md
@@ -237,18 +237,22 @@ const container = ec2TaskDefinition.addContainer("WebContainer", {
 
 You can specify container properties when you add them to the task definition, or with various methods, e.g.:
 
+To add add port mappings when adding to the task definition, specify the `portMappings` option:
+
 ```ts
 taskDefinition.addContainer("WebContainer", {
   image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
   memoryLimitMiB: 1024,
   portMappings: [{ containerPort: 3000 }]
-})
+});
 ```
 
+To add port mappings directly to a container definition, call `addPortMappings()`:
+
 ```ts
 container.addPortMappings({
   containerPort: 3000
-})
+});
 ```
 
 To add data volumes to a task definition, call `addVolume()`: