-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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.
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
docs(vpc): update VPC documentation in README and API #3810
Conversation
Try to address common gotchas with the VPC component in the package documentation. Addresses part of #3704.
packages/@aws-cdk/aws-ec2/README.md
Outdated
|
||
```ts | ||
import ec2 = require('@aws-cdk/aws-ec2'); | ||
How many Availability Zones are available depends on the *region* and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
Minor rephrase on 1st line: "The number of availability zones that are available depend on ..."
-
I was aware that AZs are dependent on the region but didn't know they were dependent on the account. Are they?
-
Link to this page would be useful - https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#using-regions-availability-zones-describe
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Yes, although this mostly only happens when new AZs are introduced and there is a whitelisting period.
account, and import the subnet configuration. Looking up can be done by VPC | ||
ID, but more flexibly by searching for a specific tag on the VPC. | ||
|
||
The import does assume that the VPC will be *symmetric*, i.e. that there are |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What happens if this assumption is not true? Specify that.
Fixes #3810. |
Pull Request Checklist
|
Thank you for contributing! Your pull request is now being automatically merged. |
Codebuild (Continuous Integration) build failed for current commits. Please check log and resolve before PR is merged. |
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
|
Try to address common gotchas with the VPC component in the
package documentation.
Addresses part of #3704.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license