Skip to content

docs(autoscaling): improve documentation of default used for the desiredCapacity property #5208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

docs(autoscaling): improve documentation of default used for the desiredCapacity property #5208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down