Skip to content

Commit ac9ce88

Browse files
authored
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*
1 parent 9c1c031 commit ac9ce88

File tree

19 files changed

+31
-31
lines changed

19 files changed

+31
-31
lines changed

packages/@aws-cdk/aws-eks-v2-alpha/lib/k8s-manifest.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export interface KubernetesManifestProps extends KubernetesManifestOptions {
116116
*/
117117
export class KubernetesManifest extends Construct {
118118
/**
119-
* The CloudFormation reosurce type.
119+
* The CloudFormation resource type.
120120
*/
121121
public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-KubernetesResource';
122122

packages/@aws-cdk/aws-eks-v2-alpha/lib/k8s-object-value.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export interface KubernetesObjectValueProps {
5353
*/
5454
export class KubernetesObjectValue extends Construct {
5555
/**
56-
* The CloudFormation reosurce type.
56+
* The CloudFormation resource type.
5757
*/
5858
public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-KubernetesObjectValue';
5959

packages/@aws-cdk/integ-tests-alpha/lib/assertions/providers/lambda-handler/types.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ export interface AwsApiCallRequest {
134134
*
135135
* If you are using the SdkRequest to perform more of a query to return
136136
* a single value to use, then this should be set to 'true'. For example,
137-
* you could make a StepFunctions.startExecution api call and retreive the
137+
* you could make a StepFunctions.startExecution api call and retrieve the
138138
* `executionArn` from the response.
139139
*
140140
* @default 'false'
@@ -216,9 +216,9 @@ export interface AssertionRequest {
216216
* Needed to access the whole message via getAtt() on the custom resource.
217217
*/
218218
export interface AssertionResult {
219-
/**
220-
* The result of an assertion
221-
*/
219+
/**
220+
* The result of an assertion
221+
*/
222222
readonly assertion: string;
223223

224224
/**

packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-status-widget.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export interface AlarmStatusWidgetProps {
6666
* You can specify one or more alarm states in the value for this field.
6767
* The alarm states that you can specify are ALARM, INSUFFICIENT_DATA, and OK.
6868
*
69-
* If you omit this field or specify an empty array, all the alarms specifed in alarms are displayed.
69+
* If you omit this field or specify an empty array, all the alarms specified in alarms are displayed.
7070
*
7171
* @default - all the alarms specified in alarms are displayed.
7272
*/

packages/aws-cdk-lib/aws-codedeploy/lib/ecs/deployment-group.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export interface EcsBlueGreenDeploymentConfig {
6666
* The load balancer listener used to route test traffic to the 'green' ECS task set during a blue-green deployment.
6767
*
6868
* During a blue-green deployment, validation can occur after test traffic has been re-routed and before production
69-
* traffic has been re-routed to the 'green' ECS task set. You can specify one or more Lambda funtions in the
69+
* traffic has been re-routed to the 'green' ECS task set. You can specify one or more Lambda functions in the
7070
* deployment's AppSpec file that run during the AfterAllowTestTraffic hook. The functions can run validation tests.
7171
* If a validation test fails, a deployment rollback is triggered. If the validation tests succeed, the next hook in
7272
* the deployment lifecycle, BeforeAllowTraffic, is triggered.
@@ -203,7 +203,7 @@ export class EcsDeploymentGroup extends DeploymentGroupBase implements IEcsDeplo
203203
* @returns a Construct representing a reference to an existing Deployment Group
204204
*/
205205
public static fromEcsDeploymentGroupAttributes(
206-
scope:Construct,
206+
scope: Construct,
207207
id: string,
208208
attrs: EcsDeploymentGroupAttributes): IEcsDeploymentGroup {
209209
return new ImportedEcsDeploymentGroup(scope, id, attrs);

packages/aws-cdk-lib/aws-codepipeline-actions/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,15 @@ const eventPattern = {
112112
},
113113
};
114114
declare const repo: codecommit.Repository;
115-
declare const lambdaFuntion: lambda.Function;
115+
declare const lambdaFunction: lambda.Function;
116116
const sourceOutput = new codepipeline.Artifact();
117117
const sourceAction = new codepipeline_actions.CodeCommitSourceAction({
118118
actionName: 'CodeCommit',
119119
repository: repo,
120120
output: sourceOutput,
121121
customEventRule: {
122122
eventPattern,
123-
target: new targets.LambdaFunction(lambdaFuntion),
123+
target: new targets.LambdaFunction(lambdaFunction),
124124
}
125125
});
126126
```

packages/aws-cdk-lib/aws-codepipeline-actions/lib/lambda/invoke-action.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ export class LambdaInvokeAction extends Action {
111111
resources: ['*'],
112112
}));
113113

114-
// allow pipeline to invoke this lambda functionn
114+
// allow pipeline to invoke this lambda function
115115
this.props.lambda.grantInvoke(options.role);
116116

117117
// allow the Role access to the Bucket, if there are any inputs/outputs

packages/aws-cdk-lib/aws-cognito/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ configure an MFA token and use it for sign in. It also allows for the users to u
323323
[time-based one time password
324324
(TOTP)](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html).
325325

326-
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`.
326+
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`.
327327
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).
328328

329329
```ts
@@ -850,7 +850,7 @@ const pool = new cognito.UserPool(this, 'Pool');
850850

851851
const clientWriteAttributes = (new cognito.ClientAttributes())
852852
.withStandardAttributes({fullname: true, email: true})
853-
.withCustomAttributes('favouritePizza', 'favouriteBeverage');
853+
.withCustomAttributes('favoritePizza', 'favoriteBeverage');
854854

855855
const clientReadAttributes = clientWriteAttributes
856856
.withStandardAttributes({emailVerified: true})

packages/aws-cdk-lib/aws-cognito/lib/user-pool-attr.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ export interface StandardAttributes {
8080
readonly profilePicture?: StandardAttribute;
8181

8282
/**
83-
* The user's preffered username, different from the immutable user name.
83+
* The user's preferred username, different from the immutable user name.
8484
* @default - see the defaults under `StandardAttribute`
8585
*/
8686
readonly preferredUsername?: StandardAttribute;
@@ -438,7 +438,7 @@ export interface StandardAttributesMask {
438438
readonly profilePicture?: boolean;
439439

440440
/**
441-
* The user's preffered username, different from the immutable user name.
441+
* The user's preferred username, different from the immutable user name.
442442
* @default false
443443
*/
444444
readonly preferredUsername?: boolean;

packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/base.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { IUserPool } from '../user-pool';
66
export class ProviderAttribute {
77
/** The email attribute provided by Apple */
88
public static readonly APPLE_EMAIL = new ProviderAttribute('email');
9-
/** The email verified atribute provided by Apple */
9+
/** The email verified attribute provided by Apple */
1010
public static readonly APPLE_EMAIL_VERIFIED = new ProviderAttribute('email_verified');
1111
/** The name attribute provided by Apple */
1212
public static readonly APPLE_NAME = new ProviderAttribute('name');

packages/aws-cdk-lib/aws-ecs/lib/base/task-definition.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ export interface TaskDefinitionProps extends CommonTaskDefinitionProps {
136136
readonly placementConstraints?: PlacementConstraint[];
137137

138138
/**
139-
* The task launch type compatiblity requirement.
139+
* The task launch type compatibility requirement.
140140
*/
141141
readonly compatibility: Compatibility;
142142

packages/aws-cdk-lib/aws-ecs/lib/cluster.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ export class Cluster extends Resource implements ICluster {
146146
/**
147147
* Return whether the given object is a Cluster
148148
*/
149-
public static isCluster(x: any) : x is Cluster {
150-
return x !== null && typeof(x) === 'object' && CLUSTER_SYMBOL in x;
149+
public static isCluster(x: any): x is Cluster {
150+
return x !== null && typeof (x) === 'object' && CLUSTER_SYMBOL in x;
151151
}
152152

153153
/**
@@ -877,7 +877,7 @@ export class Cluster extends Resource implements ICluster {
877877
}
878878

879879
/**
880-
* This method returns the specifed CloudWatch metric for this cluster.
880+
* This method returns the specified CloudWatch metric for this cluster.
881881
*/
882882
public metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric {
883883
return new cloudwatch.Metric({

packages/aws-cdk-lib/aws-efs/lib/efs-file-system.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -749,7 +749,7 @@ export class FileSystem extends FileSystemBase {
749749
throw new Error('Cannot configure \'replicationConfiguration\' when \'replicationOverwriteProtection\' is set to \'DISABLED\'');
750750
}
751751

752-
// we explictly use 'undefined' to represent 'false' to maintain backwards compatibility since
752+
// we explicitly use 'undefined' to represent 'false' to maintain backwards compatibility since
753753
// its considered an actual change in CloudFormations eyes, even though they have the same meaning.
754754
const encrypted = props.encrypted ?? (FeatureFlags.of(this).isEnabled(
755755
cxapi.EFS_DEFAULT_ENCRYPTION_AT_REST) ? true : undefined);
@@ -855,7 +855,7 @@ export class FileSystem extends FileSystemBase {
855855

856856
// We now have to create the mount target for each of the mentioned subnet
857857

858-
// we explictly use FeatureFlags to maintain backwards compatibility
858+
// we explicitly use FeatureFlags to maintain backwards compatibility
859859
const useMountTargetOrderInsensitiveLogicalID = FeatureFlags.of(this).isEnabled(cxapi.EFS_MOUNTTARGET_ORDERINSENSITIVE_LOGICAL_ID);
860860
this.mountTargetsAvailable = [];
861861
if (useMountTargetOrderInsensitiveLogicalID) {

packages/aws-cdk-lib/aws-eks/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -803,7 +803,7 @@ By default, CDK will create a new python lambda function to apply your k8s manif
803803

804804
```ts
805805
const handlerRole = iam.Role.fromRoleArn(this, 'HandlerRole', 'arn:aws:iam::123456789012:role/lambda-role');
806-
// get the serivceToken from the custom resource provider
806+
// get the serviceToken from the custom resource provider
807807
const functionArn = lambda.Function.fromFunctionName(this, 'ProviderOnEventFunc', 'ProviderframeworkonEvent-XXX').functionArn;
808808
const kubectlProvider = eks.KubectlProvider.fromKubectlProviderAttributes(this, 'KubectlProvider', {
809809
functionArn,

packages/aws-cdk-lib/aws-eks/lib/addon.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface AddonProps {
2828
*/
2929
readonly addonName: string;
3030
/**
31-
* Version of the Add-On. You can check all available versions with describe-addon-versons.
31+
* Version of the Add-On. You can check all available versions with describe-addon-versions.
3232
* For example, this lists all available versions for the `eks-pod-identity-agent` addon:
3333
* $ aws eks describe-addon-versions --addon-name eks-pod-identity-agent \
3434
* --query 'addons[*].addonVersions[*].addonVersion'

packages/aws-cdk-lib/aws-eks/lib/aws-auth.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ export class AwsAuth extends Construct {
123123
// aws-auth is always part of the cluster stack, and since resources commonly take
124124
// a dependency on the cluster, allowing those resources to be in a different stack,
125125
// will create a circular dependency. granted, it won't always be the case,
126-
// but we opted for the more causious and restrictive approach for now.
126+
// but we opted for the more cautious and restrictive approach for now.
127127
throw new Error(`${construct.node.path} should be defined in the scope of the ${thisStack.stackName} stack to prevent circular dependencies`);
128128
}
129129
}

packages/aws-cdk-lib/aws-eks/lib/k8s-manifest.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export interface KubernetesManifestProps extends KubernetesManifestOptions {
116116
*/
117117
export class KubernetesManifest extends Construct {
118118
/**
119-
* The CloudFormation reosurce type.
119+
* The CloudFormation resource type.
120120
*/
121121
public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-KubernetesResource';
122122

@@ -189,7 +189,7 @@ export class KubernetesManifest extends Construct {
189189
}
190190

191191
/**
192-
* Inject the necessary ingress annontations if possible (and requested).
192+
* Inject the necessary ingress annotations if possible (and requested).
193193
*
194194
* @see https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/guide/ingress/annotations/
195195
*/

packages/aws-cdk-lib/aws-eks/lib/k8s-object-value.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export interface KubernetesObjectValueProps {
5353
*/
5454
export class KubernetesObjectValue extends Construct {
5555
/**
56-
* The CloudFormation reosurce type.
56+
* The CloudFormation resource type.
5757
*/
5858
public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-KubernetesObjectValue';
5959

packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/apigateway/base-types.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import * as sfn from '../../../aws-stepfunctions';
22

33
/** Http Methods that API Gateway supports */
44
export enum HttpMethod {
5-
/** Retreive data from a server at the specified resource */
5+
/** Retrieve data from a server at the specified resource */
66
GET = 'GET',
77

88
/** Send data to the API endpoint to create or udpate a resource */
@@ -17,7 +17,7 @@ export enum HttpMethod {
1717
/** Apply partial modifications to the resource */
1818
PATCH = 'PATCH',
1919

20-
/** Retreive data from a server at the specified resource without the response body */
20+
/** Retrieve data from a server at the specified resource without the response body */
2121
HEAD = 'HEAD',
2222

2323
/** Return data describing what other methods and operations the server supports */

0 commit comments

Comments
 (0)