Address PR feedback

aws · Sep 25, 2019 · 3d42b1c · 3d42b1c
1 parent a738d53
commit 3d42b1c
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 18 deletions.
diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/base/application-load-balanced-service-base.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/base/application-load-balanced-service-base.ts
@@ -28,7 +28,7 @@ export interface ApplicationLoadBalancedServiceBaseProps {
   readonly vpc?: IVpc;
 
   /**
-   * The properties required to create a new task definition. One of TaskDefinition or TaskImageOptions needs to be defined.
+   * The properties required to create a new task definition. TaskDefinition or TaskImageOptions must be specified, but not both.
    *
    * @default none
    */
@@ -97,7 +97,7 @@ export interface ApplicationLoadBalancedServiceBaseProps {
 
 export interface ApplicationLoadBalancedTaskImageOptions {
   /**
-   * The image used to start a container. One of image or taskDefinition must be specified.
+   * The image used to start a container. Image or taskDefinition must be specified, not both.
    *
    * @default - none
    */

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/base/network-load-balanced-service-base.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/base/network-load-balanced-service-base.ts
@@ -27,7 +27,7 @@ export interface NetworkLoadBalancedServiceBaseProps {
   readonly vpc?: IVpc;
 
   /**
-   * The image used to start a container. One of taskImageOptions or taskDefinition must be specified.
+   * The image used to start a container. TaskDefinition or TaskImageOptions must be specified, but not both.
    *
    * @default - none
    */
@@ -88,7 +88,7 @@ export interface NetworkLoadBalancedServiceBaseProps {
 
 export interface NetworkLoadBalancedTaskImageOptions {
   /**
-   * The image used to start a container. One of image or taskDefinition must be specified.
+   * The image used to start a container. Image or taskDefinition must be specified, but not both.
    *
    * @default - none
    */

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/base/scheduled-task-base.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/base/scheduled-task-base.ts
@@ -44,7 +44,7 @@ export interface ScheduledTaskBaseProps {
 
 export interface ScheduledTaskImageProps {
   /**
-   * The image used to start a container. One of image or taskDefinition must be specified.
+   * The image used to start a container. Image or taskDefinition must be specified, but not both.
    *
    * @default - none
    */

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/ecs/application-load-balanced-ecs-service.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/ecs/application-load-balanced-ecs-service.ts
@@ -8,7 +8,7 @@ import { ApplicationLoadBalancedServiceBase, ApplicationLoadBalancedServiceBaseP
 export interface ApplicationLoadBalancedEc2ServiceProps extends ApplicationLoadBalancedServiceBaseProps {
 
   /**
-   * The task definition to use for tasks in the service. One of image or taskDefinition must be specified.
+   * The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both..
    *
    * [disable-awslint:ref-via-interface]
    *

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/ecs/network-load-balanced-ecs-service.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/ecs/network-load-balanced-ecs-service.ts
@@ -7,7 +7,7 @@ import { NetworkLoadBalancedServiceBase, NetworkLoadBalancedServiceBaseProps } f
  */
 export interface NetworkLoadBalancedEc2ServiceProps extends NetworkLoadBalancedServiceBaseProps {
   /**
-   * The task definition to use for tasks in the service. One of image or taskDefinition must be specified.
+   * The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both..
    *
    * [disable-awslint:ref-via-interface]
    *

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/ecs/scheduled-ecs-task.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/ecs/scheduled-ecs-task.ts
@@ -7,16 +7,16 @@ import { ScheduledTaskBase, ScheduledTaskBaseProps, ScheduledTaskImageProps } fr
  */
 export interface ScheduledEc2TaskProps extends ScheduledTaskBaseProps {
   /**
-   * The properties to define if using an existing TaskDefinition in this construct. Only one of
-   * ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions can be defined.
+   * The properties to define if using an existing TaskDefinition in this construct.
+   * ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.
    *
    * @default none
    */
   readonly scheduledEc2TaskDefinitionOptions?: ScheduledEc2TaskDefinitionOptions;
 
   /**
-   * The properties to define if the construct is to create a TaskDefinition. Only one of
-   * ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions can be defined.
+   * The properties to define if the construct is to create a TaskDefinition.
+   * ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.
    *
    * @default none
    */

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/application-load-balanced-fargate-service.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/application-load-balanced-fargate-service.ts
@@ -7,7 +7,7 @@ import { ApplicationLoadBalancedServiceBase, ApplicationLoadBalancedServiceBaseP
  */
 export interface ApplicationLoadBalancedFargateServiceProps extends ApplicationLoadBalancedServiceBaseProps {
   /**
-   * The task definition to use for tasks in the service. One of image or taskDefinition must be specified.
+   * The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
    *
    * [disable-awslint:ref-via-interface]
    *

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/network-load-balanced-fargate-service.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/network-load-balanced-fargate-service.ts
@@ -7,7 +7,7 @@ import { NetworkLoadBalancedServiceBase, NetworkLoadBalancedServiceBaseProps } f
  */
 export interface NetworkLoadBalancedFargateServiceProps extends NetworkLoadBalancedServiceBaseProps {
   /**
-   * The task definition to use for tasks in the service. One of image or taskDefinition must be specified.
+   * The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
    *
    * [disable-awslint:ref-via-interface]
    *

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/scheduled-fargate-task.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/scheduled-fargate-task.ts
@@ -7,16 +7,16 @@ import { ScheduledTaskBase, ScheduledTaskBaseProps, ScheduledTaskImageProps } fr
  */
 export interface ScheduledFargateTaskProps extends ScheduledTaskBaseProps {
   /**
-   * The properties to define if using an existing TaskDefinition in this construct. Only one of
-   * ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions can be defined.
+   * The properties to define if using an existing TaskDefinition in this construct.
+   * ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.
    *
    * @default none
    */
   readonly scheduledFargateTaskDefinitionOptions?: ScheduledFargateTaskDefinitionOptions;
 
   /**
-   * The properties to define if the construct is to create a TaskDefinition. Only one of
-   * ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions can be defined.
+   * The properties to define if the construct is to create a TaskDefinition.
+   * ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions can be defined, but not both.
    *
    * @default none
    */
@@ -58,7 +58,7 @@ export interface ScheduledFargateTaskImageOptions extends ScheduledTaskImageProp
  */
 export interface ScheduledFargateTaskDefinitionOptions extends ScheduledTaskBaseProps {
   /**
-   * The task definition to use for tasks in the service. One of image or taskDefinition must be specified.
+   * The task definition to use for tasks in the service. Image or taskDefinition must be specified, but not both.
    *
    * [disable-awslint:ref-via-interface]
    *