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

docs(rds): invalid master username #5076

Merged
merged 3 commits into from
May 26, 2020
Merged

docs(rds): invalid master username #5076

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c03ff27
fix(docs) RDS: invalid master username
spg Nov 18, 2019
19ad9cb
Merge branch 'master' into fix-docs-rds-admin-username
May 24, 2020
d18d999
Merge branch 'master' into fix-docs-rds-admin-username
mergify[bot] May 26, 2020
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
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-rds/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ your instances will be launched privately or publicly:
const cluster = new DatabaseCluster(this, 'Database', {
engine: DatabaseClusterEngine.AURORA,
masterUser: {
username: 'admin'
username: 'clusteradmin'
Copy link
Contributor

Choose a reason for hiding this comment

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

should we add a validation that will help people avoid this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure about this. According to the docs, the master username blacklist varies by database engine: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html

To properly validate, the CDK would have to be aware of all reserved words for all available engines. The list of reserved words might be quite large.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok fair enough. Perhaps we can add this link to the docs of username and recommend that users look at that?

},
instanceProps: {
instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.SMALL),
Expand Down