Fixed 'causes an error' stragglers

biffgaut · biffgaut · commit aef08ef7354d · 2026-01-29T15:03:39.000-05:00
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-kinesisfirehose-s3/README.adoc b/source/patterns/@aws-solutions-constructs/aws-eventbridge-kinesisfirehose-s3/README.adoc
@@ -106,15 +106,15 @@ new EventbridgeToKinesisFirehoseToS3(this, "test-eventbridge-firehose-s3",
 |*Name* |*Type* |*Description*
 |existingEventBusInterface?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html[`events.IEventBus`]
-|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-an error.
+|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps`
+causes an error.
 
 |eventBusProps?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html[`events.EventBusProps`]
 |Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
 this value to `{}` will create a custom EventBus using all default properties. If neither this nor
 `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-`existingEventBusInterface` results an error.
+`existingEventBusInterface` causes an error.
 
 |eventRuleProps
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html[`events.RuleProps`]
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-kinesisfirehose-s3/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-eventbridge-kinesisfirehose-s3/lib/index.ts
@@ -27,8 +27,8 @@ import { KinesisFirehoseToS3 } from '@aws-solutions-constructs/aws-kinesisfireho
  */
 export interface EventbridgeToKinesisFirehoseToS3Props {
   /**
-   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-   * an error.
+   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps`
+   * causes an error.
    *
    * @default - None
    */
@@ -37,7 +37,7 @@ export interface EventbridgeToKinesisFirehoseToS3Props {
    * Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
    * this value to `{}` will create a custom EventBus using all default properties. If neither this nor
    * `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-   * `existingEventBusInterface` results an error.
+   * `existingEventBusInterface` causes an error.
    *
    * @default - None
    */
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-kinesisstreams/README.adoc b/source/patterns/@aws-solutions-constructs/aws-eventbridge-kinesisstreams/README.adoc
@@ -112,15 +112,15 @@ new EventbridgeToKinesisStreams(this, "test-eventbridge-kinesis-streams",
 |*Name* |*Type* |*Description*
 |existingEventBusInterface?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html[`events.IEventBus`]
-|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-an error.
+|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps`
+causes an error.
 
 |eventBusProps?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html[`events.EventBusProps`]
 |Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
 this value to `{}` will create a custom EventBus using all default properties. If neither this nor
 `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-`existingEventBusInterface` results an error.
+`existingEventBusInterface` causes an error.
 
 |eventRuleProps
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html[`events.RuleProps`]
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-kinesisstreams/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-eventbridge-kinesisstreams/lib/index.ts
@@ -25,8 +25,8 @@ import { overrideProps } from '@aws-solutions-constructs/core';
  */
 export interface EventbridgeToKinesisStreamsProps {
   /**
-   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-   * an error.
+   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps`
+   * causes an error.
    *
    * @default - None
    */
@@ -35,7 +35,7 @@ export interface EventbridgeToKinesisStreamsProps {
    * Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
    * this value to `{}` will create a custom EventBus using all default properties. If neither this nor
    * `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-   * `existingEventBusInterface` results an error.
+   * `existingEventBusInterface` causes an error.
    *
    * @default - None
    */
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-lambda/README.adoc b/source/patterns/@aws-solutions-constructs/aws-eventbridge-lambda/README.adoc
@@ -131,15 +131,15 @@ new EventbridgeToLambda(this, "test-eventbridge-lambda",
 
 |existingEventBusInterface?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html[`events.IEventBus`]
-|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-an error.
+|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps`
+causes an error.
 
 |eventBusProps?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html[`events.EventBusProps`]
 |Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
 this value to `{}` will create a custom EventBus using all default properties. If neither this nor
 `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-`existingEventBusInterface` results an error.
+`existingEventBusInterface` causes an error.
 
 |eventRuleProps
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html[`events.RuleProps`]
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-lambda/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-eventbridge-lambda/lib/index.ts
@@ -37,8 +37,8 @@ export interface EventbridgeToLambdaProps {
    */
   readonly lambdaFunctionProps?: lambda.FunctionProps;
   /**
-   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-   * an error.
+   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps`
+   * causes an error.
    *
    * @default - None
    */
@@ -47,7 +47,7 @@ export interface EventbridgeToLambdaProps {
    * Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
    * this value to `{}` will create a custom EventBus using all default properties. If neither this nor
    * `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-   * `existingEventBusInterface` results an error.
+   * `existingEventBusInterface` causes an error.
    *
    * @default - None
    */
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-sns/README.adoc b/source/patterns/@aws-solutions-constructs/aws-eventbridge-sns/README.adoc
@@ -150,15 +150,15 @@ constructStack.getEncryptionKey().addToResourcePolicy(policyStatement);
 
 |existingEventBusInterface?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html[`events.IEventBus`]
-|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-an error.
+|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` 
+causes an error.
 
 |eventBusProps?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html[`events.EventBusProps`]
 |Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
 this value to `{}` will create a custom EventBus using all default properties. If neither this nor
 `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-`existingEventBusInterface` results an error.
+`existingEventBusInterface` causes an error.
 
 |enableEncryptionWithCustomerManagedKey? |`boolean` |If no key is
 provided, this flag determines whether the SNS Topic is encrypted with a
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-sns/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-eventbridge-sns/lib/index.ts
@@ -39,7 +39,7 @@ export interface EventbridgeToSnsProps {
      * Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
      * this value to `{}` will create a custom EventBus using all default properties. If neither this nor
      * `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-     * `existingEventBusInterface` results an error.
+     * `existingEventBusInterface` causes an error.
      *
      * @default - None
      */
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-sqs/README.adoc b/source/patterns/@aws-solutions-constructs/aws-eventbridge-sqs/README.adoc
@@ -137,15 +137,15 @@ constructStack.getEncryptionKey().addToResourcePolicy(policyStatement);
 |*Name* |*Type* |*Description*
 |existingEventBusInterface?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html[`events.IEventBus`]
-|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-an error.
+|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` 
+causes an error.
 
 |eventBusProps?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html[`events.EventBusProps`]
 |Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
 this value to `{}` will create a custom EventBus using all default properties. If neither this nor
 `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-`existingEventBusInterface` results an error.
+`existingEventBusInterface` causes an error.
 
 |eventRuleProps
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html[`events.RuleProps`]
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-sqs/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-eventbridge-sqs/lib/index.ts
@@ -26,8 +26,8 @@ import { overrideProps } from '@aws-solutions-constructs/core';
  */
 export interface EventbridgeToSqsProps {
   /**
-   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-   * an error.
+   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` 
+   * causes an error.
    *
    * @default - None
    */
@@ -36,7 +36,7 @@ export interface EventbridgeToSqsProps {
    * Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
    * this value to `{}` will create a custom EventBus using all default properties. If neither this nor
    * `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-   * `existingEventBusInterface` results an error.
+   * `existingEventBusInterface` causes an error.
    *
    * @default - None
    */
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-stepfunctions/README.adoc b/source/patterns/@aws-solutions-constructs/aws-eventbridge-stepfunctions/README.adoc
@@ -129,15 +129,15 @@ sfn.StateMachine
 
 |existingEventBusInterface?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html[`events.IEventBus`]
-|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-an error.
+|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` 
+causes an error.
 
 |eventBusProps?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html[`events.EventBusProps`]
 |Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
 this value to `{}` will create a custom EventBus using all default properties. If neither this nor
 `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-`existingEventBusInterface` results an error.
+`existingEventBusInterface` causes an error.
 
 |eventRuleProps
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html[`events.RuleProps`]
diff --git a/source/patterns/@aws-solutions-constructs/aws-eventbridge-stepfunctions/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-eventbridge-stepfunctions/lib/index.ts
@@ -26,8 +26,8 @@ import * as logs from 'aws-cdk-lib/aws-logs';
  */
 export interface EventbridgeToStepfunctionsProps {
   /**
-   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-   * an error.
+   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` 
+   * causes an error.
    *
    * @default - None
    */
@@ -36,7 +36,7 @@ export interface EventbridgeToStepfunctionsProps {
    * Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
    * this value to `{}` will create a custom EventBus using all default properties. If neither this nor
    * `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-   * `existingEventBusInterface` results an error.
+   * `existingEventBusInterface` causes an error.
    *
    * @default - None
    */
diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-eventbridge/README.adoc b/source/patterns/@aws-solutions-constructs/aws-fargate-eventbridge/README.adoc
@@ -160,15 +160,15 @@ service. This must be the container in the existingFargateServiceObject
 
 |existingEventBusInterface?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html[`events.IEventBus`]
-|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-an error.
+|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` 
+causes an error.
 
 |eventBusProps?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html[`events.EventBusProps`]
 |Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
 this value to `{}` will create a custom EventBus using all default properties. If neither this nor
 `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-`existingEventBusInterface` results an error.
+`existingEventBusInterface` causes an error.
 
 |eventBusEnvironmentVariableName? |`string` |Optional Name for the
 container environment variable set to the DynamoDB table name. Default:
diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-eventbridge/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-eventbridge/lib/index.ts
@@ -105,8 +105,8 @@ export interface FargateToEventbridgeProps {
    */
   readonly existingContainerDefinitionObject?: ecs.ContainerDefinition;
   /**
-   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-   * an error.
+   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` 
+   * causes an error.
    *
    * @default - None
    */
@@ -115,7 +115,7 @@ export interface FargateToEventbridgeProps {
    * Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
    * this value to `{}` will create a custom EventBus using all default properties. If neither this nor
    * `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-   * `existingEventBusInterface` results an error.
+   * `existingEventBusInterface` causes an error.
    *
    * @default - None
    */
diff --git a/source/patterns/@aws-solutions-constructs/aws-lambda-eventbridge/README.adoc b/source/patterns/@aws-solutions-constructs/aws-lambda-eventbridge/README.adoc
@@ -113,15 +113,15 @@ new LambdaToEventbridge(this, "LambdaToEventbridgePattern", new LambdaToEventbri
 
 |existingEventBusInterface?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html[`events.IEventBus`]
-|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-an error.
+|Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` 
+causes an error.
 
 |eventBusProps?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html[`events.EventBusProps`]
 |Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
 this value to `{}` will create a custom EventBus using all default properties. If neither this nor
 `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-`existingEventBusInterface` results an error.
+`existingEventBusInterface` causes an error.
 
 |existingVpc?
 |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
diff --git a/source/patterns/@aws-solutions-constructs/aws-lambda-eventbridge/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-lambda-eventbridge/lib/index.ts
@@ -36,8 +36,8 @@ export interface LambdaToEventbridgeProps {
    */
   readonly lambdaFunctionProps?: lambda.FunctionProps;
   /**
-   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` is
-   * an error.
+   * Optional - user provided custom EventBus for this construct to use. Providing both this and `eventBusProps` 
+   * causes an error.
    *
    * @default - None
    */
@@ -46,7 +46,7 @@ export interface LambdaToEventbridgeProps {
    * Optional - user provided properties to override the default properties when creating a custom EventBus. Setting
    * this value to `{}` will create a custom EventBus using all default properties. If neither this nor
    * `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
-   * `existingEventBusInterface` results an error.
+   * `existingEventBusInterface` causes an error.
    *
    * @default - None
    */
diff --git a/source/patterns/@aws-solutions-constructs/aws-route53-alb/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-route53-alb/lib/index.ts
@@ -65,8 +65,8 @@ export interface Route53ToAlbProps {
    */
   readonly albLoggingBucketProps?: s3.BucketProps,
   /**
-   * Custom properties for a new VPC. Providing both this and existingVpc is
-   * an error. If an existingAlb or existing Private Hosted Zone is provided, those
+   * Custom properties for a new VPC. Providing both this and existingVpc 
+   * causes an error. If an existingAlb or existing Private Hosted Zone is provided, those
    * already exist in a VPC so this value cannot be provided.
    *
    * @default - None

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ export interface EventbridgeToSnsProps {`
`39`	`39`	`* Optional - user provided properties to override the default properties when creating a custom EventBus. Setting`
`40`	`40`	* this value to `{}` will create a custom EventBus using all default properties. If neither this nor
`41`	`41`	* `existingEventBusInterface` is provided the construct will use the default EventBus. Providing both this and
`42`		- * `existingEventBusInterface` results an error.
	`42`	+ * `existingEventBusInterface` causes an error.
`43`	`43`	`*`
`44`	`44`	`* @default - None`
`45`	`45`	`*/`