From 71321ed84a4dc91cf8aee5357fb8b482d9a37a08 Mon Sep 17 00:00:00 2001 From: Shiv Lakshminarayan Date: Wed, 27 Nov 2019 00:20:02 -0800 Subject: [PATCH] docs(autoscaling): improve documentation of desiredCapacity property --- packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts b/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts index 6dd65993db8b4..67cfd5dbc7086 100644 --- a/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts +++ b/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts @@ -44,7 +44,9 @@ export interface CommonAutoScalingGroupProps { /** * Initial amount of instances in the fleet * - * @default 1 + * @default - If minCapacity is provided, it will be used as the desired capacity. + * If minCapacity is not set, then maxCapacity will be used if it's provided. + * If neither minCapacity or maxCapacity is set, a default of 1 will be used. */ readonly desiredCapacity?: number;