docs(cdk-lib): fix typos (#33165)

### Issue # (if applicable) None ### Reason for this change Fixed typos in code comments. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Jan 26, 2025 · ac9ce88 · ac9ce88
1 parent 9c1c031
commit ac9ce88
Show file tree

Hide file tree

Showing 19 changed files with 31 additions and 31 deletions.
diff --git a/packages/@aws-cdk/aws-eks-v2-alpha/lib/k8s-manifest.ts b/packages/@aws-cdk/aws-eks-v2-alpha/lib/k8s-manifest.ts
@@ -116,7 +116,7 @@ export interface KubernetesManifestProps extends KubernetesManifestOptions {
  */
 export class KubernetesManifest extends Construct {
   /**
-   * The CloudFormation reosurce type.
+   * The CloudFormation resource type.
    */
   public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-KubernetesResource';
 

diff --git a/packages/@aws-cdk/aws-eks-v2-alpha/lib/k8s-object-value.ts b/packages/@aws-cdk/aws-eks-v2-alpha/lib/k8s-object-value.ts
@@ -53,7 +53,7 @@ export interface KubernetesObjectValueProps {
  */
 export class KubernetesObjectValue extends Construct {
   /**
-   * The CloudFormation reosurce type.
+   * The CloudFormation resource type.
    */
   public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-KubernetesObjectValue';
 

diff --git a/packages/@aws-cdk/integ-tests-alpha/lib/assertions/providers/lambda-handler/types.ts b/packages/@aws-cdk/integ-tests-alpha/lib/assertions/providers/lambda-handler/types.ts
@@ -134,7 +134,7 @@ export interface AwsApiCallRequest {
    *
    * If you are using the SdkRequest to perform more of a query to return
    * a single value to use, then this should be set to 'true'. For example,
-   * you could make a StepFunctions.startExecution api call and retreive the
+   * you could make a StepFunctions.startExecution api call and retrieve the
    * `executionArn` from the response.
    *
    * @default 'false'
@@ -216,9 +216,9 @@ export interface AssertionRequest {
  * Needed to access the whole message via getAtt() on the custom resource.
  */
 export interface AssertionResult {
-/**
- * The result of an assertion
- */
+  /**
+   * The result of an assertion
+   */
   readonly assertion: string;
 
   /**

diff --git a/packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-status-widget.ts b/packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-status-widget.ts
@@ -66,7 +66,7 @@ export interface AlarmStatusWidgetProps {
    * You can specify one or more alarm states in the value for this field.
    * The alarm states that you can specify are ALARM, INSUFFICIENT_DATA, and OK.
    *
-   * If you omit this field or specify an empty array, all the alarms specifed in alarms are displayed.
+   * If you omit this field or specify an empty array, all the alarms specified in alarms are displayed.
    *
    * @default -  all the alarms specified in alarms are displayed.
    */

diff --git a/packages/aws-cdk-lib/aws-codedeploy/lib/ecs/deployment-group.ts b/packages/aws-cdk-lib/aws-codedeploy/lib/ecs/deployment-group.ts
@@ -66,7 +66,7 @@ export interface EcsBlueGreenDeploymentConfig {
    * The load balancer listener used to route test traffic to the 'green' ECS task set during a blue-green deployment.
    *
    * During a blue-green deployment, validation can occur after test traffic has been re-routed and before production
-   * traffic has been re-routed to the 'green' ECS task set.  You can specify one or more Lambda funtions in the
+   * traffic has been re-routed to the 'green' ECS task set.  You can specify one or more Lambda functions in the
    * deployment's AppSpec file that run during the AfterAllowTestTraffic hook. The functions can run validation tests.
    * If a validation test fails, a deployment rollback is triggered. If the validation tests succeed, the next hook in
    * the deployment lifecycle, BeforeAllowTraffic, is triggered.
@@ -203,7 +203,7 @@ export class EcsDeploymentGroup extends DeploymentGroupBase implements IEcsDeplo
    * @returns a Construct representing a reference to an existing Deployment Group
    */
   public static fromEcsDeploymentGroupAttributes(
-    scope:Construct,
+    scope: Construct,
     id: string,
     attrs: EcsDeploymentGroupAttributes): IEcsDeploymentGroup {
     return new ImportedEcsDeploymentGroup(scope, id, attrs);

diff --git a/packages/aws-cdk-lib/aws-codepipeline-actions/README.md b/packages/aws-cdk-lib/aws-codepipeline-actions/README.md
@@ -112,15 +112,15 @@ const eventPattern = {
   },
 };
 declare const repo: codecommit.Repository;
-declare const lambdaFuntion: lambda.Function;
+declare const lambdaFunction: lambda.Function;
 const sourceOutput = new codepipeline.Artifact();
 const sourceAction = new codepipeline_actions.CodeCommitSourceAction({
   actionName: 'CodeCommit',
   repository: repo,
   output: sourceOutput,
   customEventRule: {
     eventPattern,
-    target: new targets.LambdaFunction(lambdaFuntion),
+    target: new targets.LambdaFunction(lambdaFunction),
   }
 });
 ```

diff --git a/packages/aws-cdk-lib/aws-codepipeline-actions/lib/lambda/invoke-action.ts b/packages/aws-cdk-lib/aws-codepipeline-actions/lib/lambda/invoke-action.ts
@@ -111,7 +111,7 @@ export class LambdaInvokeAction extends Action {
       resources: ['*'],
     }));
 
-    // allow pipeline to invoke this lambda functionn
+    // allow pipeline to invoke this lambda function
     this.props.lambda.grantInvoke(options.role);
 
     // allow the Role access to the Bucket, if there are any inputs/outputs

diff --git a/packages/aws-cdk-lib/aws-cognito/README.md b/packages/aws-cdk-lib/aws-cognito/README.md
@@ -323,7 +323,7 @@ configure an MFA token and use it for sign in. It also allows for the users to u
 [time-based one time password
 (TOTP)](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html).
 
-If you want to enable email-based MFA, set `email` propety to the Amazon SES email-sending configuration and set `featurePlan` to `FeaturePlan.ESSENTIALS` or `FeaturePlan.PLUS`.
+If you want to enable email-based MFA, set `email` property to the Amazon SES email-sending configuration and set `featurePlan` to `FeaturePlan.ESSENTIALS` or `FeaturePlan.PLUS`.
 For more information, see [SMS and email message MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-sms-email-message.html).
 
 ```ts
@@ -850,7 +850,7 @@ const pool = new cognito.UserPool(this, 'Pool');
 
 const clientWriteAttributes = (new cognito.ClientAttributes())
   .withStandardAttributes({fullname: true, email: true})
-  .withCustomAttributes('favouritePizza', 'favouriteBeverage');
+  .withCustomAttributes('favoritePizza', 'favoriteBeverage');
 
 const clientReadAttributes = clientWriteAttributes
   .withStandardAttributes({emailVerified: true})

diff --git a/packages/aws-cdk-lib/aws-cognito/lib/user-pool-attr.ts b/packages/aws-cdk-lib/aws-cognito/lib/user-pool-attr.ts
@@ -80,7 +80,7 @@ export interface StandardAttributes {
   readonly profilePicture?: StandardAttribute;
 
   /**
-   * The user's preffered username, different from the immutable user name.
+   * The user's preferred username, different from the immutable user name.
    * @default - see the defaults under `StandardAttribute`
    */
   readonly preferredUsername?: StandardAttribute;
@@ -438,7 +438,7 @@ export interface StandardAttributesMask {
   readonly profilePicture?: boolean;
 
   /**
-   * The user's preffered username, different from the immutable user name.
+   * The user's preferred username, different from the immutable user name.
    * @default false
    */
   readonly preferredUsername?: boolean;

diff --git a/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/base.ts b/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/base.ts
@@ -6,7 +6,7 @@ import { IUserPool } from '../user-pool';
 export class ProviderAttribute {
   /** The email attribute provided by Apple */
   public static readonly APPLE_EMAIL = new ProviderAttribute('email');
-  /** The email verified atribute provided by Apple */
+  /** The email verified attribute provided by Apple */
   public static readonly APPLE_EMAIL_VERIFIED = new ProviderAttribute('email_verified');
   /** The name attribute provided by Apple */
   public static readonly APPLE_NAME = new ProviderAttribute('name');

diff --git a/packages/aws-cdk-lib/aws-ecs/lib/base/task-definition.ts b/packages/aws-cdk-lib/aws-ecs/lib/base/task-definition.ts
@@ -136,7 +136,7 @@ export interface TaskDefinitionProps extends CommonTaskDefinitionProps {
   readonly placementConstraints?: PlacementConstraint[];
 
   /**
-   * The task launch type compatiblity requirement.
+   * The task launch type compatibility requirement.
    */
   readonly compatibility: Compatibility;
 

diff --git a/packages/aws-cdk-lib/aws-ecs/lib/cluster.ts b/packages/aws-cdk-lib/aws-ecs/lib/cluster.ts
@@ -146,8 +146,8 @@ export class Cluster extends Resource implements ICluster {
   /**
    * Return whether the given object is a Cluster
    */
-  public static isCluster(x: any) : x is Cluster {
-    return x !== null && typeof(x) === 'object' && CLUSTER_SYMBOL in x;
+  public static isCluster(x: any): x is Cluster {
+    return x !== null && typeof (x) === 'object' && CLUSTER_SYMBOL in x;
   }
 
   /**
@@ -877,7 +877,7 @@ export class Cluster extends Resource implements ICluster {
   }
 
   /**
-   * This method returns the specifed CloudWatch metric for this cluster.
+   * This method returns the specified CloudWatch metric for this cluster.
    */
   public metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return new cloudwatch.Metric({

diff --git a/packages/aws-cdk-lib/aws-efs/lib/efs-file-system.ts b/packages/aws-cdk-lib/aws-efs/lib/efs-file-system.ts
@@ -749,7 +749,7 @@ export class FileSystem extends FileSystemBase {
       throw new Error('Cannot configure \'replicationConfiguration\' when \'replicationOverwriteProtection\' is set to \'DISABLED\'');
     }
 
-    // we explictly use 'undefined' to represent 'false' to maintain backwards compatibility since
+    // we explicitly use 'undefined' to represent 'false' to maintain backwards compatibility since
     // its considered an actual change in CloudFormations eyes, even though they have the same meaning.
     const encrypted = props.encrypted ?? (FeatureFlags.of(this).isEnabled(
       cxapi.EFS_DEFAULT_ENCRYPTION_AT_REST) ? true : undefined);
@@ -855,7 +855,7 @@ export class FileSystem extends FileSystemBase {
 
     // We now have to create the mount target for each of the mentioned subnet
 
-    // we explictly use FeatureFlags to maintain backwards compatibility
+    // we explicitly use FeatureFlags to maintain backwards compatibility
     const useMountTargetOrderInsensitiveLogicalID = FeatureFlags.of(this).isEnabled(cxapi.EFS_MOUNTTARGET_ORDERINSENSITIVE_LOGICAL_ID);
     this.mountTargetsAvailable = [];
     if (useMountTargetOrderInsensitiveLogicalID) {

diff --git a/packages/aws-cdk-lib/aws-eks/README.md b/packages/aws-cdk-lib/aws-eks/README.md
@@ -803,7 +803,7 @@ By default, CDK will create a new python lambda function to apply your k8s manif
 
 ```ts
 const handlerRole = iam.Role.fromRoleArn(this, 'HandlerRole', 'arn:aws:iam::123456789012:role/lambda-role');
-// get the serivceToken from the custom resource provider
+// get the serviceToken from the custom resource provider
 const functionArn = lambda.Function.fromFunctionName(this, 'ProviderOnEventFunc', 'ProviderframeworkonEvent-XXX').functionArn;
 const kubectlProvider = eks.KubectlProvider.fromKubectlProviderAttributes(this, 'KubectlProvider', {
   functionArn,

diff --git a/packages/aws-cdk-lib/aws-eks/lib/addon.ts b/packages/aws-cdk-lib/aws-eks/lib/addon.ts
@@ -28,7 +28,7 @@ export interface AddonProps {
    */
   readonly addonName: string;
   /**
-   * Version of the Add-On. You can check all available versions with describe-addon-versons.
+   * Version of the Add-On. You can check all available versions with describe-addon-versions.
    * For example, this lists all available versions for the `eks-pod-identity-agent` addon:
    * $ aws eks describe-addon-versions --addon-name eks-pod-identity-agent \
    * --query 'addons[*].addonVersions[*].addonVersion'

diff --git a/packages/aws-cdk-lib/aws-eks/lib/aws-auth.ts b/packages/aws-cdk-lib/aws-eks/lib/aws-auth.ts
@@ -123,7 +123,7 @@ export class AwsAuth extends Construct {
       // aws-auth is always part of the cluster stack, and since resources commonly take
       // a dependency on the cluster, allowing those resources to be in a different stack,
       // will create a circular dependency. granted, it won't always be the case,
-      // but we opted for the more causious and restrictive approach for now.
+      // but we opted for the more cautious and restrictive approach for now.
       throw new Error(`${construct.node.path} should be defined in the scope of the ${thisStack.stackName} stack to prevent circular dependencies`);
     }
   }

diff --git a/packages/aws-cdk-lib/aws-eks/lib/k8s-manifest.ts b/packages/aws-cdk-lib/aws-eks/lib/k8s-manifest.ts
@@ -116,7 +116,7 @@ export interface KubernetesManifestProps extends KubernetesManifestOptions {
  */
 export class KubernetesManifest extends Construct {
   /**
-   * The CloudFormation reosurce type.
+   * The CloudFormation resource type.
    */
   public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-KubernetesResource';
 
@@ -189,7 +189,7 @@ export class KubernetesManifest extends Construct {
   }
 
   /**
-   * Inject the necessary ingress annontations if possible (and requested).
+   * Inject the necessary ingress annotations if possible (and requested).
    *
    * @see https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/guide/ingress/annotations/
    */

diff --git a/packages/aws-cdk-lib/aws-eks/lib/k8s-object-value.ts b/packages/aws-cdk-lib/aws-eks/lib/k8s-object-value.ts
@@ -53,7 +53,7 @@ export interface KubernetesObjectValueProps {
  */
 export class KubernetesObjectValue extends Construct {
   /**
-   * The CloudFormation reosurce type.
+   * The CloudFormation resource type.
    */
   public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-KubernetesObjectValue';
 

diff --git a/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/apigateway/base-types.ts b/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/apigateway/base-types.ts
@@ -2,7 +2,7 @@ import * as sfn from '../../../aws-stepfunctions';
 
 /** Http Methods that API Gateway supports */
 export enum HttpMethod {
-  /** Retreive data from a server at the specified resource */
+  /** Retrieve data from a server at the specified resource */
   GET = 'GET',
 
   /** Send data to the API endpoint to create or udpate a resource */
@@ -17,7 +17,7 @@ export enum HttpMethod {
   /** Apply partial modifications to the resource */
   PATCH = 'PATCH',
 
-  /** Retreive data from a server at the specified resource without the response body */
+  /** Retrieve data from a server at the specified resource without the response body */
   HEAD = 'HEAD',
 
   /** Return data describing what other methods and operations the server supports */