From 81cf548b115e0e65d8dedf54d3efabdcbfda536b Mon Sep 17 00:00:00 2001 From: Robert Djurasaj Date: Fri, 12 Mar 2021 09:14:35 -0700 Subject: [PATCH] chore(docs): fix typos across the board (#13435) Fix bunch of docstring, docs and param typos. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --- packages/@aws-cdk/aws-apigateway/lib/cors.ts | 2 +- .../@aws-cdk/aws-apigateway/lib/gateway-response.ts | 2 +- packages/@aws-cdk/aws-apigateway/lib/resource.ts | 6 +++--- packages/@aws-cdk/aws-apigateway/lib/restapi.ts | 4 ++-- packages/@aws-cdk/aws-apigateway/lib/usage-plan.ts | 2 +- packages/@aws-cdk/aws-apigatewayv2/README.md | 2 +- packages/@aws-cdk/aws-batch/README.md | 4 ++-- packages/@aws-cdk/aws-batch/lib/exposed-secret.ts | 12 ++++++------ .../aws-batch/lib/job-definition-image-config.ts | 2 +- packages/@aws-cdk/aws-certificatemanager/README.md | 2 +- .../aws-certificatemanager/lib/certificate.ts | 8 ++++---- .../lib/dns-validated-certificate.ts | 2 +- packages/@aws-cdk/aws-dynamodb/README.md | 4 ++-- packages/@aws-cdk/aws-dynamodb/lib/table.ts | 4 ++-- packages/@aws-cdk/aws-ec2/lib/launch-template.ts | 2 +- packages/@aws-cdk/aws-ec2/lib/network-util.ts | 4 ++-- packages/@aws-cdk/aws-ec2/lib/vpc.ts | 2 +- packages/@aws-cdk/aws-lambda/lib/alias.ts | 2 +- packages/@aws-cdk/aws-lambda/lib/code.ts | 2 +- packages/@aws-cdk/aws-lambda/lib/function.ts | 4 ++-- packages/@aws-cdk/aws-lambda/lib/lambda-version.ts | 2 +- packages/@aws-cdk/aws-route53/README.md | 2 +- .../lib/vpc-endpoint-service-domain-name.ts | 6 +++--- packages/@aws-cdk/aws-s3-assets/README.md | 2 +- packages/@aws-cdk/aws-s3/lib/bucket.ts | 6 +++--- packages/@aws-cdk/aws-stepfunctions/README.md | 2 +- .../aws-stepfunctions/lib/step-functions-task.ts | 4 ++-- packages/@aws-cdk/pipelines/README.md | 6 +++--- 28 files changed, 51 insertions(+), 51 deletions(-) diff --git a/packages/@aws-cdk/aws-apigateway/lib/cors.ts b/packages/@aws-cdk/aws-apigateway/lib/cors.ts index feb7572779de9..d0cc6ee3e5a79 100644 --- a/packages/@aws-cdk/aws-apigateway/lib/cors.ts +++ b/packages/@aws-cdk/aws-apigateway/lib/cors.ts @@ -64,7 +64,7 @@ export interface CorsOptions { * Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) * can be cached. * - * To disable caching altogther use `disableCache: true`. + * To disable caching altogether use `disableCache: true`. * * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age * @default - browser-specific (see reference) diff --git a/packages/@aws-cdk/aws-apigateway/lib/gateway-response.ts b/packages/@aws-cdk/aws-apigateway/lib/gateway-response.ts index 7c2aabbd0704e..0ab490a893051 100644 --- a/packages/@aws-cdk/aws-apigateway/lib/gateway-response.ts +++ b/packages/@aws-cdk/aws-apigateway/lib/gateway-response.ts @@ -206,7 +206,7 @@ export class ResponseType { */ public static readonly WAF_FILTERED = new ResponseType('WAF_FILTERED'); - /** A custom response type to suppport future cases. */ + /** A custom response type to support future cases. */ public static of(type: string): ResponseType { return new ResponseType(type.toUpperCase()); } diff --git a/packages/@aws-cdk/aws-apigateway/lib/resource.ts b/packages/@aws-cdk/aws-apigateway/lib/resource.ts index 49d0bf0356d80..714e99bce7a0b 100644 --- a/packages/@aws-cdk/aws-apigateway/lib/resource.ts +++ b/packages/@aws-cdk/aws-apigateway/lib/resource.ts @@ -282,12 +282,12 @@ export abstract class ResourceBase extends ResourceConstruct implements IResourc // prepare responseParams const integrationResponseParams: { [p: string]: string } = { }; - const methodReponseParams: { [p: string]: boolean } = { }; + const methodResponseParams: { [p: string]: boolean } = { }; for (const [name, value] of Object.entries(headers)) { const key = `method.response.header.${name}`; integrationResponseParams[key] = value; - methodReponseParams[key] = true; + methodResponseParams[key] = true; } return this.addMethod('OPTIONS', new MockIntegration({ @@ -297,7 +297,7 @@ export abstract class ResourceBase extends ResourceConstruct implements IResourc ], }), { methodResponses: [ - { statusCode: `${statusCode}`, responseParameters: methodReponseParams }, + { statusCode: `${statusCode}`, responseParameters: methodResponseParams }, ], }); diff --git a/packages/@aws-cdk/aws-apigateway/lib/restapi.ts b/packages/@aws-cdk/aws-apigateway/lib/restapi.ts index 32c400c52d23e..51a6ae53a7040 100644 --- a/packages/@aws-cdk/aws-apigateway/lib/restapi.ts +++ b/packages/@aws-cdk/aws-apigateway/lib/restapi.ts @@ -174,7 +174,7 @@ export interface RestApiBaseProps { /** * Represents the props that all Rest APIs share. - * @deprecated - superceded by `RestApiBaseProps` + * @deprecated - superseded by `RestApiBaseProps` */ export interface RestApiOptions extends RestApiBaseProps, ResourceOptions { } @@ -441,7 +441,7 @@ export abstract class RestApiBase extends Resource implements IRestApi { /** * Metric for the total number API requests in a given period. * - * Default: samplecount over 5 minutes + * Default: sample count over 5 minutes */ public metricCount(props?: cloudwatch.MetricOptions): cloudwatch.Metric { return this.cannedMetric(ApiGatewayMetrics.countSum, { diff --git a/packages/@aws-cdk/aws-apigateway/lib/usage-plan.ts b/packages/@aws-cdk/aws-apigateway/lib/usage-plan.ts index ad807d4a7d2d0..49b3ee19cd017 100644 --- a/packages/@aws-cdk/aws-apigateway/lib/usage-plan.ts +++ b/packages/@aws-cdk/aws-apigateway/lib/usage-plan.ts @@ -181,7 +181,7 @@ export class UsagePlan extends Resource { public addApiKey(apiKey: IApiKey): void { const prefix = 'UsagePlanKeyResource'; - // Postfixing apikey id only from the 2nd child, to keep physicalIds of UsagePlanKey for existing CDK apps unmodifed. + // Postfixing apikey id only from the 2nd child, to keep physicalIds of UsagePlanKey for existing CDK apps unmodified. const id = this.node.tryFindChild(prefix) ? `${prefix}:${Names.nodeUniqueId(apiKey.node)}` : prefix; new CfnUsagePlanKey(this, id, { diff --git a/packages/@aws-cdk/aws-apigatewayv2/README.md b/packages/@aws-cdk/aws-apigatewayv2/README.md index d8278a800a00f..7a71fc00491a1 100644 --- a/packages/@aws-cdk/aws-apigatewayv2/README.md +++ b/packages/@aws-cdk/aws-apigatewayv2/README.md @@ -187,7 +187,7 @@ const api = new HttpApi(stack, 'HttpProxyProdApi', { }); ``` -To associate a specifc `Stage` to a custom domain mapping - +To associate a specific `Stage` to a custom domain mapping - ```ts api.addStage('beta', { diff --git a/packages/@aws-cdk/aws-batch/README.md b/packages/@aws-cdk/aws-batch/README.md index 99ea697ae4f28..48d5b7edf65d8 100644 --- a/packages/@aws-cdk/aws-batch/README.md +++ b/packages/@aws-cdk/aws-batch/README.md @@ -148,7 +148,7 @@ const computeEnv = batch.ComputeEnvironment.fromComputeEnvironmentArn(this, 'imp ### Change the baseline AMI of the compute resources -Ocassionally, you will need to deviate from the default processing AMI. +Occasionally, you will need to deviate from the default processing AMI. ECS Optimized Amazon Linux 2 example: @@ -186,7 +186,7 @@ const jobQueue = new batch.JobQueue(stack, 'JobQueue', { { // Defines a collection of compute resources to handle assigned batch jobs computeEnvironment, - // Order determines the allocation order for jobs (i.e. Lower means higher preferance for job assignment) + // Order determines the allocation order for jobs (i.e. Lower means higher preference for job assignment) order: 1, }, ], diff --git a/packages/@aws-cdk/aws-batch/lib/exposed-secret.ts b/packages/@aws-cdk/aws-batch/lib/exposed-secret.ts index 351095536add0..6ee6e3587208b 100644 --- a/packages/@aws-cdk/aws-batch/lib/exposed-secret.ts +++ b/packages/@aws-cdk/aws-batch/lib/exposed-secret.ts @@ -7,20 +7,20 @@ import * as ssm from '@aws-cdk/aws-ssm'; export class ExposedSecret { /** * Use Secrets Manager Secret - * @param optionaName - The name of the option + * @param optionName - The name of the option * @param secret - A secret from secrets manager */ - public static fromSecretsManager(optionaName: string, secret: secretsmanager.ISecret): ExposedSecret { - return new ExposedSecret(optionaName, secret.secretArn); + public static fromSecretsManager(optionName: string, secret: secretsmanager.ISecret): ExposedSecret { + return new ExposedSecret(optionName, secret.secretArn); } /** * User Parameters Store Parameter - * @param optionaName - The name of the option + * @param optionName - The name of the option * @param parameter - A parameter from parameters store */ - public static fromParametersStore(optionaName: string, parameter: ssm.IParameter): ExposedSecret { - return new ExposedSecret(optionaName, parameter.parameterArn); + public static fromParametersStore(optionName: string, parameter: ssm.IParameter): ExposedSecret { + return new ExposedSecret(optionName, parameter.parameterArn); } /** diff --git a/packages/@aws-cdk/aws-batch/lib/job-definition-image-config.ts b/packages/@aws-cdk/aws-batch/lib/job-definition-image-config.ts index 191024a197a11..ba3c0c1740597 100644 --- a/packages/@aws-cdk/aws-batch/lib/job-definition-image-config.ts +++ b/packages/@aws-cdk/aws-batch/lib/job-definition-image-config.ts @@ -37,7 +37,7 @@ class TaskDefinition { } /** - * Internal function to allow the Batch Job task defintion + * Internal function to allow the Batch Job task definition * to match the CDK requirements of an EC2 task definition. * * @internal diff --git a/packages/@aws-cdk/aws-certificatemanager/README.md b/packages/@aws-cdk/aws-certificatemanager/README.md index 24202429ac5df..24f1e72a3cb20 100644 --- a/packages/@aws-cdk/aws-certificatemanager/README.md +++ b/packages/@aws-cdk/aws-certificatemanager/README.md @@ -102,7 +102,7 @@ new acm.Certificate(this, 'Certificate', { ## Cross-region Certificates ACM certificates that are used with CloudFront -- or higher-level constructs which rely on CloudFront -- must be in the `us-east-1` region. -The `DnsValidatedCertificate` construct exists to faciliate creating these certificates cross-region. This resource can only be used with +The `DnsValidatedCertificate` construct exists to facilitate creating these certificates cross-region. This resource can only be used with Route53-based DNS validation. ```ts diff --git a/packages/@aws-cdk/aws-certificatemanager/lib/certificate.ts b/packages/@aws-cdk/aws-certificatemanager/lib/certificate.ts index df3d3988847ad..eac04dcb6df05 100644 --- a/packages/@aws-cdk/aws-certificatemanager/lib/certificate.ts +++ b/packages/@aws-cdk/aws-certificatemanager/lib/certificate.ts @@ -55,7 +55,7 @@ export interface CertificateProps { readonly validationMethod?: ValidationMethod; /** - * How to validate this certifcate + * How to validate this certificate * * @default CertificateValidation.fromEmail() */ @@ -100,7 +100,7 @@ export interface CertificationValidationProps { */ export class CertificateValidation { /** - * Validate the certifcate with DNS + * Validate the certificate with DNS * * IMPORTANT: If `hostedZone` is not specified, DNS records must be added * manually and the stack will not complete creating until the records are @@ -116,7 +116,7 @@ export class CertificateValidation { } /** - * Validate the certifcate with automatically created DNS records in multiple + * Validate the certificate with automatically created DNS records in multiple * Amazon Route 53 hosted zones. * * @param hostedZones a map of hosted zones where DNS records must be created @@ -130,7 +130,7 @@ export class CertificateValidation { } /** - * Validate the certifcate with Email + * Validate the certificate with Email * * IMPORTANT: if you are creating a certificate as part of your stack, the stack * will not complete creating until you read and follow the instructions in the diff --git a/packages/@aws-cdk/aws-certificatemanager/lib/dns-validated-certificate.ts b/packages/@aws-cdk/aws-certificatemanager/lib/dns-validated-certificate.ts index f1a5cd442e9d1..98637e43409ed 100644 --- a/packages/@aws-cdk/aws-certificatemanager/lib/dns-validated-certificate.ts +++ b/packages/@aws-cdk/aws-certificatemanager/lib/dns-validated-certificate.ts @@ -32,7 +32,7 @@ export interface DnsValidatedCertificateProps extends CertificateProps { * aws-cn partition, the default endpoint is not working now, hence the right endpoint * need to be specified through this prop. * - * Route53 is not been offically launched in China, it is only available for AWS + * Route53 is not been officially launched in China, it is only available for AWS * internal accounts now. To make DnsValidatedCertificate work for internal accounts * now, a special endpoint needs to be provided. * diff --git a/packages/@aws-cdk/aws-dynamodb/README.md b/packages/@aws-cdk/aws-dynamodb/README.md index ac540dd11670c..2f43d83f88c4f 100644 --- a/packages/@aws-cdk/aws-dynamodb/README.md +++ b/packages/@aws-cdk/aws-dynamodb/README.md @@ -65,7 +65,7 @@ https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.Read You can have DynamoDB automatically raise and lower the read and write capacities of your table by setting up autoscaling. You can use this to either keep your -tables at a desired utilization level, or by scaling up and down at preconfigured +tables at a desired utilization level, or by scaling up and down at pre-configured times of the day: Auto-scaling is only relevant for tables with the billing mode, PROVISIONED. @@ -125,7 +125,7 @@ const globalTable = new dynamodb.Table(this, 'Table', { All user data stored in Amazon DynamoDB is fully encrypted at rest. When creating a new table, you can choose to encrypt using the following customer master keys (CMK) to encrypt your table: * AWS owned CMK - By default, all tables are encrypted under an AWS owned customer master key (CMK) in the DynamoDB service account (no additional charges apply). -* AWS managed CMK - AWS KMS keys (one per region) are created in your account, managed, and used on your behalf by AWS DynamoDB (AWS KMS chages apply). +* AWS managed CMK - AWS KMS keys (one per region) are created in your account, managed, and used on your behalf by AWS DynamoDB (AWS KMS charges apply). * Customer managed CMK - You have full control over the KMS key used to encrypt the DynamoDB Table (AWS KMS charges apply). Creating a Table encrypted with a customer managed CMK: diff --git a/packages/@aws-cdk/aws-dynamodb/lib/table.ts b/packages/@aws-cdk/aws-dynamodb/lib/table.ts index 9334192f5610d..84156abcec214 100644 --- a/packages/@aws-cdk/aws-dynamodb/lib/table.ts +++ b/packages/@aws-cdk/aws-dynamodb/lib/table.ts @@ -1555,7 +1555,7 @@ export class Table extends TableBase { if (encryptionType === undefined) { encryptionType = props.encryptionKey != null - // If there is a configured encyptionKey, the encryption is implicitly CUSTOMER_MANAGED + // If there is a configured encryptionKey, the encryption is implicitly CUSTOMER_MANAGED ? TableEncryption.CUSTOMER_MANAGED // Otherwise, if severSideEncryption is enabled, it's AWS_MANAGED; else undefined (do not set anything) : props.serverSideEncryption ? TableEncryption.AWS_MANAGED : undefined; @@ -1613,7 +1613,7 @@ export enum AttributeType { } /** - * DyanmoDB's Read/Write capacity modes. + * DynamoDB's Read/Write capacity modes. */ export enum BillingMode { /** diff --git a/packages/@aws-cdk/aws-ec2/lib/launch-template.ts b/packages/@aws-cdk/aws-ec2/lib/launch-template.ts index 3b5b39f9b6370..fdc03755c0268 100644 --- a/packages/@aws-cdk/aws-ec2/lib/launch-template.ts +++ b/packages/@aws-cdk/aws-ec2/lib/launch-template.ts @@ -646,7 +646,7 @@ export class LaunchTemplate extends Resource implements ILaunchTemplate, iam.IGr */ public get connections(): Connections { if (!this._connections) { - throw new Error('LaunchTemplate can only be used as IConnectable if a securityGroup is provided when contructing it.'); + throw new Error('LaunchTemplate can only be used as IConnectable if a securityGroup is provided when constructing it.'); } return this._connections; } diff --git a/packages/@aws-cdk/aws-ec2/lib/network-util.ts b/packages/@aws-cdk/aws-ec2/lib/network-util.ts index 301c8ad5ed980..5c7a7c9b7027e 100644 --- a/packages/@aws-cdk/aws-ec2/lib/network-util.ts +++ b/packages/@aws-cdk/aws-ec2/lib/network-util.ts @@ -244,7 +244,7 @@ export class CidrBlock { } /* - * The maximum IP in the CIDR Blcok e.g. '10.0.8.255' + * The maximum IP in the CIDR Block e.g. '10.0.8.255' */ public maxIp(): string { // min + (2^(32-mask)) - 1 [zero needs to count] @@ -252,7 +252,7 @@ export class CidrBlock { } /* - * The minimum IP in the CIDR Blcok e.g. '10.0.0.0' + * The minimum IP in the CIDR Block e.g. '10.0.0.0' */ public minIp(): string { return NetworkUtils.numToIp(this.minAddress()); diff --git a/packages/@aws-cdk/aws-ec2/lib/vpc.ts b/packages/@aws-cdk/aws-ec2/lib/vpc.ts index 2a4e524fc5150..8d878dde26024 100644 --- a/packages/@aws-cdk/aws-ec2/lib/vpc.ts +++ b/packages/@aws-cdk/aws-ec2/lib/vpc.ts @@ -1597,7 +1597,7 @@ export class Subnet extends Resource implements ISubnet { } /** - * Adds an entry to this subnets route table that points to the passed NATGatwayId + * Adds an entry to this subnets route table that points to the passed NATGatewayId * @param natGatewayId The ID of the NAT gateway */ public addDefaultNatRoute(natGatewayId: string) { diff --git a/packages/@aws-cdk/aws-lambda/lib/alias.ts b/packages/@aws-cdk/aws-lambda/lib/alias.ts index 3e22118644ac6..4287ffde73d6e 100644 --- a/packages/@aws-cdk/aws-lambda/lib/alias.ts +++ b/packages/@aws-cdk/aws-lambda/lib/alias.ts @@ -196,7 +196,7 @@ export class Alias extends QualifiedFunctionBase implements IAlias { } public metric(metricName: string, props: cloudwatch.MetricOptions = {}): cloudwatch.Metric { - // Metrics on Aliases need the "bare" function name, and the alias' ARN, this differes from the base behavior. + // Metrics on Aliases need the "bare" function name, and the alias' ARN, this differs from the base behavior. return super.metric(metricName, { dimensions: { FunctionName: this.lambda.functionName, diff --git a/packages/@aws-cdk/aws-lambda/lib/code.ts b/packages/@aws-cdk/aws-lambda/lib/code.ts index fec1e1821270e..b78859bf3515c 100644 --- a/packages/@aws-cdk/aws-lambda/lib/code.ts +++ b/packages/@aws-cdk/aws-lambda/lib/code.ts @@ -60,7 +60,7 @@ export abstract class Code { /** * Loads the function code from an asset created by a Docker build. * - * By defaut, the asset is expected to be located at `/asset` in the + * By default, the asset is expected to be located at `/asset` in the * image. * * @param path The path to the directory containing the Docker file diff --git a/packages/@aws-cdk/aws-lambda/lib/function.ts b/packages/@aws-cdk/aws-lambda/lib/function.ts index 8d487276a6176..1f9857ac35b1a 100644 --- a/packages/@aws-cdk/aws-lambda/lib/function.ts +++ b/packages/@aws-cdk/aws-lambda/lib/function.ts @@ -214,7 +214,7 @@ export interface FunctionOptions extends EventInvokeConfigOptions { /** * A list of layers to add to the function's execution environment. You can configure your Lambda function to pull in * additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies - * that can be used by mulitple functions. + * that can be used by multiple functions. * * @default - No layers. */ @@ -563,7 +563,7 @@ export class Function extends FunctionBase { }); this.grantPrincipal = this.role; - // add additonal managed policies when necessary + // add additional managed policies when necessary if (props.filesystem) { const config = props.filesystem.config; if (config.policies) { diff --git a/packages/@aws-cdk/aws-lambda/lib/lambda-version.ts b/packages/@aws-cdk/aws-lambda/lib/lambda-version.ts index b51d866ac815d..94f3e0b326b16 100644 --- a/packages/@aws-cdk/aws-lambda/lib/lambda-version.ts +++ b/packages/@aws-cdk/aws-lambda/lib/lambda-version.ts @@ -221,7 +221,7 @@ export class Version extends QualifiedFunctionBase implements IVersion { } public metric(metricName: string, props: cloudwatch.MetricOptions = {}): cloudwatch.Metric { - // Metrics on Aliases need the "bare" function name, and the alias' ARN, this differes from the base behavior. + // Metrics on Aliases need the "bare" function name, and the alias' ARN, this differs from the base behavior. return super.metric(metricName, { dimensions: { FunctionName: this.lambda.functionName, diff --git a/packages/@aws-cdk/aws-route53/README.md b/packages/@aws-cdk/aws-route53/README.md index aa5bf109b7473..9f36aa7f58765 100644 --- a/packages/@aws-cdk/aws-route53/README.md +++ b/packages/@aws-cdk/aws-route53/README.md @@ -191,7 +191,7 @@ This DNS name can also be guaranteed to match up with the backend certificate. Before consumers can use the private DNS name, you must verify that you have control of the domain/subdomain. -Assuming your account has ownership of the particlar domain/subdomain, +Assuming your account has ownership of the particular domain/subdomain, this construct sets up the private DNS configuration on the endpoint service, creates all the necessary Route53 entries, and verifies domain ownership. diff --git a/packages/@aws-cdk/aws-route53/lib/vpc-endpoint-service-domain-name.ts b/packages/@aws-cdk/aws-route53/lib/vpc-endpoint-service-domain-name.ts index 2af889661098a..9098503b625f4 100644 --- a/packages/@aws-cdk/aws-route53/lib/vpc-endpoint-service-domain-name.ts +++ b/packages/@aws-cdk/aws-route53/lib/vpc-endpoint-service-domain-name.ts @@ -138,7 +138,7 @@ export class VpcEndpointServiceDomainName extends CoreConstruct { // Create the custom resource to look up the name/value pair generated by AWS // after the previous API call - const retriveNameValuePairAction = { + const retrieveNameValuePairAction = { service: 'EC2', action: 'describeVpcEndpointServiceConfigurations', parameters: { @@ -147,8 +147,8 @@ export class VpcEndpointServiceDomainName extends CoreConstruct { physicalResourceId: PhysicalResourceId.of(lookup), }; const getNames = new AwsCustomResource(this, 'GetNames', { - onCreate: retriveNameValuePairAction, - onUpdate: retriveNameValuePairAction, + onCreate: retrieveNameValuePairAction, + onUpdate: retrieveNameValuePairAction, // describeVpcEndpointServiceConfigurations can't take an ARN for granular permissions policy: AwsCustomResourcePolicy.fromSdkCalls({ resources: AwsCustomResourcePolicy.ANY_RESOURCE, diff --git a/packages/@aws-cdk/aws-s3-assets/README.md b/packages/@aws-cdk/aws-s3-assets/README.md index 7a751410a2b22..8dae008aa5444 100644 --- a/packages/@aws-cdk/aws-s3-assets/README.md +++ b/packages/@aws-cdk/aws-s3-assets/README.md @@ -143,7 +143,7 @@ const asset = new assets.Asset(this, 'BundledAsset', { ``` Use `BundlingOutput.ARCHIVED` if the bundling output contains a single archive file and -you don't want it to be zippped. +you don't want it to be zipped. ## CloudFormation Resource Metadata diff --git a/packages/@aws-cdk/aws-s3/lib/bucket.ts b/packages/@aws-cdk/aws-s3/lib/bucket.ts index 630aa9f02bfcc..c4c472a01ca94 100644 --- a/packages/@aws-cdk/aws-s3/lib/bucket.ts +++ b/packages/@aws-cdk/aws-s3/lib/bucket.ts @@ -183,7 +183,7 @@ export interface IBucket extends IResource { grantPutAcl(identity: iam.IGrantable, objectsKeyPattern?: string): iam.Grant; /** - * Grants s3:DeleteObject* permission to an IAM pricipal for objects + * Grants s3:DeleteObject* permission to an IAM principal for objects * in this bucket. * * @param identity The principal @@ -628,7 +628,7 @@ abstract class BucketBase extends Resource implements IBucket { } /** - * Grants s3:DeleteObject* permission to an IAM pricipal for objects + * Grants s3:DeleteObject* permission to an IAM principal for objects * in this bucket. * * @param identity The principal @@ -1620,7 +1620,7 @@ export class Bucket extends BucketBase { } /** - * Parse the lifecycle configuration out of the uucket props + * Parse the lifecycle configuration out of the bucket props * @param props Par */ private parseLifecycleConfiguration(): CfnBucket.LifecycleConfigurationProperty | undefined { diff --git a/packages/@aws-cdk/aws-stepfunctions/README.md b/packages/@aws-cdk/aws-stepfunctions/README.md index 8682de8dd13a9..f22d45f9f475d 100644 --- a/packages/@aws-cdk/aws-stepfunctions/README.md +++ b/packages/@aws-cdk/aws-stepfunctions/README.md @@ -295,7 +295,7 @@ parallel.next(closeOrder); ### Succeed Reaching a `Succeed` state terminates the state machine execution with a -succesful status. +successful status. ```ts const success = new sfn.Succeed(this, 'We did it!'); diff --git a/packages/@aws-cdk/aws-stepfunctions/lib/step-functions-task.ts b/packages/@aws-cdk/aws-stepfunctions/lib/step-functions-task.ts index 1d0dfcecbf773..e722594345930 100644 --- a/packages/@aws-cdk/aws-stepfunctions/lib/step-functions-task.ts +++ b/packages/@aws-cdk/aws-stepfunctions/lib/step-functions-task.ts @@ -84,7 +84,7 @@ export interface StepFunctionsTaskConfig { * Three ways to call an integrated service: Request Response, Run a Job and Wait for a Callback with Task Token. * @see https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html * - * Here, they are named as FIRE_AND_FORGET, SYNC and WAIT_FOR_TASK_TOKEN respectly. + * Here, they are named as FIRE_AND_FORGET, SYNC and WAIT_FOR_TASK_TOKEN respectfully. * * @default FIRE_AND_FORGET */ @@ -100,7 +100,7 @@ export enum ServiceIntegrationPattern { SYNC = 'SYNC', /** - * Call a service with a task token and wait until that token is returned by SendTaskSuccess/SendTaskFailure with paylaod + * Call a service with a task token and wait until that token is returned by SendTaskSuccess/SendTaskFailure with payload. */ WAIT_FOR_TASK_TOKEN = 'WAIT_FOR_TASK_TOKEN' } diff --git a/packages/@aws-cdk/pipelines/README.md b/packages/@aws-cdk/pipelines/README.md index 15e6da27613d3..5413b38fa0d16 100644 --- a/packages/@aws-cdk/pipelines/README.md +++ b/packages/@aws-cdk/pipelines/README.md @@ -432,7 +432,7 @@ the `additionalArtifacts` property. Here are some typical examples for how you might want to bring in additional files from several sources: -* Directoy from the source repository +* Directory from the source repository * Additional compiled artifacts from the synth step ### Controlling IAM permissions @@ -523,7 +523,7 @@ const validationAction = new ShellScriptAction({ }); ``` -#### Add Additional permissions to the CodeBuild Project Role for building and synthing +#### Add Additional permissions to the CodeBuild Project Role for building and synthesizing You can customize the role permissions used by the CodeBuild project so it has access to the needed resources. eg: Adding CodeArtifact repo permissions so we pull npm packages @@ -677,7 +677,7 @@ contains: assets in these storage locations *without* the use of CloudFormation template parameters. * A set of roles with permissions to access these asset locations and to execute - CloudFormation, assumeable from whatever accounts you specify under `--trust`. + CloudFormation, assumable from whatever accounts you specify under `--trust`. It is possible and safe to migrate from the old bootstrap stack to the new bootstrap stack. This will create a new S3 file asset bucket in your account