-
-
Notifications
You must be signed in to change notification settings - Fork 21
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
feat!: implements IKeyPair interface #279
Conversation
Warning Rate Limit Exceeded@udondan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 31 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe recent updates focus on enhancing the management of EC2 Key Pairs within AWS CDK, incorporating native CloudFormation support. It includes modifications in the README for better clarity on CDK version compatibility and the usage of custom KMS keys for key pair creation. Additionally, the core library has been refined by altering the inheritance model for the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
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.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (3)
- README.md (7 hunks)
- lib/index.ts (3 hunks)
- test/lib/test-stack.ts (2 hunks)
Additional comments: 3
README.md (1)
- 17-21: Consider refining the wording for better clarity and readability. For example:
- Change "CloudFormation now natively supports creating EC2 Key Pairs via [AWS::EC2::KeyPair]" to "CloudFormation now supports creating EC2 Key Pairs natively via [AWS::EC2::KeyPair]".
- In the bullet points, consider rephrasing for consistency, such as "Keys are stored in AWS Secrets Manager, as opposed to SSM Parameter Store."
lib/index.ts (2)
- 148-148: The change to extend
Resource
instead ofConstruct
and implementIKeyPair
aligns with best practices for AWS CDK resources. Ensure that all functionalities previously available are still supported or appropriately handled.- 416-423: Consider adding documentation for the
_isOsCompatible
method to clarify its purpose and potential future use. This helps maintain code readability and understandability, especially as the project evolves.
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.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- test/lib/test-stack.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- test/lib/test-stack.ts
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.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files ignored due to path filters (1)
package.json
is excluded by:!**/*.json
Files selected for processing (1)
- README.md (3 hunks)
Additional comments: 1
README.md (1)
- 28-36: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [26-28]
The phrase "installed along in the expected version" might be clearer as "installed alongside in the expected versions." Additionally, consider using the official spelling "Node.js" instead of "NodeJS" for consistency with official documentation.
- For TypeScript/NodeJS, add these to your `dependencies` in `package.json`. + For TypeScript/Node.js, add these to your `dependencies` in `package.json`.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
For direct use in an ec2 instance construct.
As
IKeyPair
was introduced with aws-cdk-lib 2.116.0 this now is the required minimum version. (peerDependency)Previously you would pass the keyPair name to an EC2 instance, which now is deprecated. You can still pass the name, so no change is required on your end yet. Nevertheless, 2.116.0 is the required min version for this pacakge now.