Skip to content
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

Jump to bottom

chore(codebuild): improve the doc for subnetSelection #26592

Merged
merged 6 commits into from
Aug 18, 2023
Merged

chore(codebuild): improve the doc for subnetSelection #26592

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
10e7c65
improve the doc for subnetSelection
pahud Aug 1, 2023
96091cb
minor
pahud Aug 1, 2023
849954e
Update project.ts
pahud Aug 3, 2023
1e0fb9f
update
pahud Aug 17, 2023
07a8b27
Merge branch 'main' into codebuild-doc
rix0rrr Aug 18, 2023
c23aaeb
Merge branch 'main' into codebuild-doc
mergify[bot] Aug 18, 2023
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
13 changes: 11 additions & 2 deletions packages/aws-cdk-lib/aws-codebuild/lib/project.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,9 +616,18 @@ export interface CommonProjectProps {
/**
* Where to place the network interfaces within the VPC.
*
* Only used if 'vpc' is supplied.
* To access AWS services, your CodeBuild project needs to be in one of the following types of subnets:
*
* 1. Subnets with access to the internet (of type PRIVATE_WITH_EGRESS).
* 2. Private subnets unconnected to the internet, but with [VPC endpoints](https://docs.aws.amazon.com/codebuild/latest/userguide/use-vpc-endpoints-with-codebuild.html) for the necessary services.
*
* If you don't specify a subnet selection, the default behavior is to use PRIVATE_WITH_EGRESS subnets first if they exist,
* then PRIVATE_WITHOUT_EGRESS, and finally PUBLIC subnets. If your VPC doesn't have PRIVATE_WITH_EGRESS subnets but you need
* AWS service access, add VPC Endpoints to your private subnets.
*
* @see https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html for more details.
*
* @default - All private subnets.
* @default - private subnets if available else public subnets
*/
readonly subnetSelection?: ec2.SubnetSelection;

Expand Down