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

fix(ec2): improve errors around subnet selection #4089

Merged
merged 3 commits into from
Sep 16, 2019
Merged

fix(ec2): improve errors around subnet selection #4089

merged 3 commits into from
Sep 16, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Sep 16, 2019

Selecting subnets by VPC and type is a confusing topic with some
API misapprehensions.

Try to fix that by renaming subnetName to subnetGroupName, and
giving more clear error messages about legal values in case of misuse.

Closes #3859.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@rix0rrr
fix(ec2): clear errors around subnet selection
a13d764 
Selecting subnets by VPC and type is a confusing topic with some
API misapprehensions.

Try to fix that by renaming `subnetName` to `subnetGroupName`, and
giving more clear error messages about legal values in case of misuse.

Closes #3859.
@rix0rrr rix0rrr requested a review from a team September 16, 2019 10:06
@rix0rrr rix0rrr self-assigned this Sep 16, 2019
@rix0rrr rix0rrr changed the title fix(ec2): clear errors around subnet selection fix(ec2): improve errors around subnet selection Sep 16, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 16, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

eladb
eladb previously approved these changes Sep 16, 2019
View reviewed changes
packages/@aws-cdk/aws-ec2/lib/vpc.ts
*
* At most one of `subnetType` and `subnetName` can be supplied.
* At most one of `subnetType` and `subnetGroupName` can be supplied.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a union-like instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe. Bit hard to change right now, and then the right thing to make union-like is the whole subnetSelection object. I predict there will be many more subnet selection requirements in the future.

packages/@aws-cdk/aws-ec2/lib/vpc.ts Outdated Show resolved Hide resolved
packages/@aws-cdk/aws-ec2/lib/vpc.ts Outdated Show resolved Hide resolved
packages/@aws-cdk/aws-ec2/lib/vpc.ts Outdated Show resolved Hide resolved
@mergify
Copy link
Contributor

mergify bot commented Sep 16, 2019

Thank you for contributing! Your pull request is now being automatically merged.

1 similar comment
@mergify
Copy link
Contributor

mergify bot commented Sep 16, 2019

Thank you for contributing! Your pull request is now being automatically merged.

@rix0rrr rix0rrr added the pr/do-not-merge This PR should not be merged at this time. label Sep 16, 2019
@mergify mergify bot dismissed eladb’s stale review September 16, 2019 12:32

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@rix0rrr rix0rrr merged commit 2392108 into master Sep 16, 2019
@rix0rrr rix0rrr deleted the huijbers/clear-error branch September 16, 2019 14:40
@rix0rrr rix0rrr added the effort/small Small work item – less than a day of effort label Sep 18, 2019
eladb pushed a commit that referenced this pull request Sep 23, 2019
@rix0rrr
fix(ec2): improve errors around subnet selection (#4089)
d8a7366 
Selecting subnets by VPC and type is a confusing topic with some
API misapprehensions.

Try to fix that by renaming `subnetName` to `subnetGroupName`, and
giving more clear error messages about legal values in case of misuse.

Closes #3859.
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eladb eladb eladb left review comments

Assignees

@rix0rrr rix0rrr

Labels
contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort pr/do-not-merge This PR should not be merged at this time.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AutoScalingGroup vpc_subnets doesn't seem to do anything
4 participants
@rix0rrr @aws-cdk-automation @eladb @NGL321