Skip to content

Commit

Permalink
docs(eks): clarify requirements to use subnetSelection (#16632)
Browse files Browse the repository at this point in the history
partially fixes: #16349 

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
peterwoodworth authored Sep 23, 2021
1 parent 41fdebb commit 5aa6ac0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion packages/@aws-cdk/aws-eks/lib/fargate-profile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface FargateProfileOptions {
* By default, all private subnets are selected. You can customize this using
* `subnetSelection`.
*
* @default - all private subnets used by theEKS cluster
* @default - all private subnets used by the EKS cluster
*/
readonly vpc?: ec2.IVpc;

Expand All @@ -55,6 +55,8 @@ export interface FargateProfileOptions {
* on Fargate are not assigned public IP addresses, so only private subnets
* (with no direct route to an Internet Gateway) are allowed.
*
* You must specify the VPC to customize the subnet selection
*
* @default - all private subnets of the VPC are selected.
*/
readonly subnetSelection?: ec2.SubnetSelection;
Expand Down

0 comments on commit 5aa6ac0

Please sign in to comment.