docs(rds): invalid master username #5076

spg · 2019-11-18T15:33:24Z

Commit Message

docs(rds): invalid master username (#5076)

End Commit Message

Fixes the following error that occurs when username is set to admin:

 5/9 | 10:13:25 AM | CREATE_FAILED        | AWS::RDS::DBCluster                         | Database (DatabaseB269D8BB) MasterUsername admin cannot be used as it is a reserved word used by the engine (Service: AmazonRDS; Status Code: 400; Error Code: InvalidParameterValue; Request ID: 0ac76793-...)

mergify · 2019-11-18T15:34:05Z

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 · 2019-11-18T15:56:14Z

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 · 2019-11-19T15:33:44Z

packages/@aws-cdk/aws-rds/README.md

@@ -25,7 +25,7 @@ your instances will be launched privately or publicly:
 const cluster = new DatabaseCluster(this, 'Database', {
    engine: DatabaseClusterEngine.AURORA,
    masterUser: {
-        username: 'admin'
+        username: 'clusteradmin'


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

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.

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

eladb · 2019-11-20T10:45:47Z

packages/@aws-cdk/aws-rds/README.md

@@ -25,7 +25,7 @@ your instances will be launched privately or publicly:
 const cluster = new DatabaseCluster(this, 'Database', {
    engine: DatabaseClusterEngine.AURORA,
    masterUser: {
-        username: 'admin'
+        username: 'clusteradmin'


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

mergify · 2019-12-16T12:33:55Z

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

mergify · 2019-12-16T13:01:09Z

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

mergify · 2019-12-16T13:53:19Z

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

mergify · 2019-12-16T14:39:02Z

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

mergify · 2019-12-16T14:52:48Z

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

mergify · 2019-12-16T15:17:59Z

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

merge this old PR

Pull request has been modified.

aws-cdk-automation · 2020-05-24T07:33:43Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 19ad9cb
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2020-05-26T07:53:00Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2020-05-26T08:45:27Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: d18d999
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2020-05-26T08:45:46Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

fix(docs) RDS: invalid master username

c03ff27

spg requested a review from skinny85 as a code owner November 18, 2019 15:33

SomayaB assigned skinny85 and rix0rrr and unassigned rix0rrr Nov 18, 2019

eladb suggested changes Nov 19, 2019

View reviewed changes

vertti mentioned this pull request Nov 20, 2019

Change masterUser username in example #5125

Closed

eladb previously requested changes Nov 20, 2019

View reviewed changes

skinny85 assigned eladb and unassigned skinny85 Nov 26, 2019

skinny85 removed their request for review November 26, 2019 20:39

aws deleted a comment from mergify bot Mar 26, 2020

eladb assigned nija-at and unassigned eladb Apr 6, 2020

nija-at changed the title ~~fix(docs) RDS: invalid master username~~ docs(rds): invalid master username May 19, 2020

nija-at previously approved these changes May 19, 2020

View reviewed changes

Merge branch 'master' into fix-docs-rds-admin-username

19ad9cb

nija-at approved these changes May 26, 2020

View reviewed changes

Merge branch 'master' into fix-docs-rds-admin-username

d18d999

mergify bot merged commit f26063f into aws:master May 26, 2020

jogold mentioned this pull request Sep 29, 2020

[rds] invalid default username when using Aurora PostgresSql #10579

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(rds): invalid master username #5076

docs(rds): invalid master username #5076

spg commented Nov 18, 2019 •

edited by nija-at

Loading

mergify bot commented Nov 18, 2019

aws-cdk-automation commented Nov 18, 2019

eladb Nov 19, 2019

spg Nov 19, 2019

eladb Nov 20, 2019

eladb Nov 20, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

aws-cdk-automation commented May 24, 2020

mergify bot commented May 26, 2020

aws-cdk-automation commented May 26, 2020

mergify bot commented May 26, 2020

docs(rds): invalid master username #5076

docs(rds): invalid master username #5076

Conversation

spg commented Nov 18, 2019 • edited by nija-at Loading

Commit Message

End Commit Message

mergify bot commented Nov 18, 2019

aws-cdk-automation commented Nov 18, 2019

AWS CodeBuild CI Report

eladb Nov 19, 2019

Choose a reason for hiding this comment

spg Nov 19, 2019

Choose a reason for hiding this comment

eladb Nov 20, 2019

Choose a reason for hiding this comment

eladb Nov 20, 2019

Choose a reason for hiding this comment

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

aws-cdk-automation commented May 24, 2020

AWS CodeBuild CI Report

mergify bot commented May 26, 2020

aws-cdk-automation commented May 26, 2020

AWS CodeBuild CI Report

mergify bot commented May 26, 2020

spg commented Nov 18, 2019 •

edited by nija-at

Loading