fix: fix typo

robertd · Mar 20, 2022 · 71362e6 · 71362e6
1 parent 6bb7f9c
commit 71362e6
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/API.md b/API.md
@@ -191,7 +191,7 @@ const ebsProps: EbsProps = { ... }
 | <code><a href="#cdk-karpenter.EbsProps.property.encrypted">encrypted</a></code> | <code>boolean</code> | Indicates whether the volume should be encrypted. |
 | <code><a href="#cdk-karpenter.EbsProps.property.iops">iops</a></code> | <code>number</code> | The number of I/O operations per second (IOPS). |
 | <code><a href="#cdk-karpenter.EbsProps.property.kmsKeyId">kmsKeyId</a></code> | <code>string</code> | The identifier of the AWS KMS key to use for Amazon EBS encryption. |
-| <code><a href="#cdk-karpenter.EbsProps.property.troughput">troughput</a></code> | <code>number</code> | Throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. |
+| <code><a href="#cdk-karpenter.EbsProps.property.throughput">throughput</a></code> | <code>number</code> | Throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. |
 | <code><a href="#cdk-karpenter.EbsProps.property.volumeSize">volumeSize</a></code> | <code>string</code> | The size of the volume, in GiBs. |
 | <code><a href="#cdk-karpenter.EbsProps.property.volumeType">volumeType</a></code> | <code>aws-cdk-lib.aws_ec2.EbsDeviceVolumeType</code> | The volume type. |
 
@@ -249,10 +249,10 @@ If KmsKeyId is specified, the encrypted state must be true. If the encrypted sta
 
 ---
 
-##### `troughput`<sup>Optional</sup> <a name="troughput" id="cdk-karpenter.EbsProps.property.troughput"></a>
+##### `throughput`<sup>Optional</sup> <a name="throughput" id="cdk-karpenter.EbsProps.property.throughput"></a>
 
 ```typescript
-public readonly troughput: number;
+public readonly throughput: number;
 ```
 
 - *Type:* number

diff --git a/README.md b/README.md
@@ -74,7 +74,7 @@ karpenter.addProvisioner('custom', {
           volumeSize: '100Gib',
           volumeType: EbsDeviceVolumeType.GP3,
           iops: 5000,
-          troughput: 1000,
+          throughput: 1000,
           kmsKeyId: 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
         },
       },

diff --git a/src/karpenter.ts b/src/karpenter.ts
@@ -233,7 +233,7 @@ export interface EbsProps {
   /**
    * Throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
    */
-  readonly troughput?: number;
+  readonly throughput?: number;
 
   /**
    * The number of I/O operations per second (IOPS).

diff --git a/test/karpenter.test.ts b/test/karpenter.test.ts
@@ -52,7 +52,7 @@ karpenter.addProvisioner('custom', {
           volumeSize: '100Gi',
           volumeType: EbsDeviceVolumeType.GP3,
           iops: 5000,
-          troughput: 1000,
+          throughput: 1000,
           kmsKeyId: 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
         },
       },
@@ -271,7 +271,7 @@ test('has custom provider', () => {
           {
             Ref: 'Cluster9EE0221C',
           },
-          '\",\"tags\":{\"Foo\":\"Bar\"},\"amiFamily\":\"AL2\",\"blockDeviceMappings\":[{\"deviceName\":\"test\",\"ebs\":{\"encrypted\":true,\"deleteOnTermination\":true,\"volumeSize\":\"100Gi\",\"volumeType\":\"gp3\",\"iops\":5000,\"troughput\":1000,\"kmsKeyId\":\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"}}]}}}]',
+          '\",\"tags\":{\"Foo\":\"Bar\"},\"amiFamily\":\"AL2\",\"blockDeviceMappings\":[{\"deviceName\":\"test\",\"ebs\":{\"encrypted\":true,\"deleteOnTermination\":true,\"volumeSize\":\"100Gi\",\"volumeType\":\"gp3\",\"iops\":5000,\"throughput\":1000,\"kmsKeyId\":\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"}}]}}}]',
         ],
       ],
     },