Skip to content

Commit

Permalink
docs(docdb): make sample snippet deployable (#13295)
Browse files Browse the repository at this point in the history
see below error when creating cluster with master username 'admin'

> MasterUsername admin cannot be used as it is a reserved word used by the engine


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
zxkane committed Mar 1, 2021
1 parent 9663093 commit 4420ac3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-docdb/README.md
Expand Up @@ -30,7 +30,7 @@ your instances will be launched privately or publicly:
```ts
const cluster = new DatabaseCluster(this, 'Database', {
masterUser: {
username: 'admin'
username: 'myuser' // NOTE: 'admin' is reserved by DocumentDB
},
instanceProps: {
instanceType: ec2.InstanceType.of(ec2.InstanceClass.R5, ec2.InstanceSize.LARGE),
Expand Down

0 comments on commit 4420ac3

Please sign in to comment.