Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cdk-lib): fix typos #33165

Merged
merged 7 commits into from
Jan 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-eks-v2-alpha/lib/k8s-manifest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-eks-v2-alpha/lib/k8s-object-value.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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);
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-codepipeline-actions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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),
}
});
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-cognito/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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})
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-cognito/lib/user-pool-attr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-ecs/lib/base/task-definition.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
6 changes: 3 additions & 3 deletions packages/aws-cdk-lib/aws-ecs/lib/cluster.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

/**
Expand Down Expand Up @@ -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({
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-efs/lib/efs-file-system.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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) {
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-eks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-eks/lib/addon.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-eks/lib/aws-auth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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`);
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-eks/lib/k8s-manifest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down Expand Up @@ -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/
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-eks/lib/k8s-object-value.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 */
Expand All @@ -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 */
Expand Down
Loading