Skip to content

Commit

Permalink
docs(rds): Fix storage allocation units (#20692)
Browse files Browse the repository at this point in the history
The upstream documentation
<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allocatedstorage>
uses "gigabytes" in one place and "GiB" everywhere else, including the
dashboard. Presumably "gibibytes" was meant, so the CDK documentation
should reflect that.

Closes #20676.

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)
   * Yes, except [linting didn't work](#20693).

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
l0b0 authored Jun 10, 2022
1 parent d4fdb4e commit 45e4e43
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-rds/lib/instance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -813,7 +813,7 @@ export interface DatabaseInstanceSourceProps extends DatabaseInstanceNewProps {
readonly timezone?: string;

/**
* The allocated storage size, specified in gigabytes (GB).
* The allocated storage size, specified in gibibytes (GiB).
*
* @default 100
*/
Expand Down

0 comments on commit 45e4e43

Please sign in to comment.