Merge pull request #1293 from guardian/aa-alpha

fix: Mark `GuKinesisLambda` and `GuSnsLambda` patterns as alpha
guardian · May 23, 2022 · 90178ca · 90178ca
2 parents 156a993 + 15df7f6
commit 90178ca
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/patterns/kinesis-lambda.ts b/src/patterns/kinesis-lambda.ts
@@ -95,6 +95,8 @@ export interface GuKinesisLambdaProps extends Omit<GuFunctionProps, "errorPercen
  * This pattern will create a new Kinesis stream by default. If you are migrating a stack from CloudFormation,
  * you will need to opt-out of this behaviour. For information on overriding the default behaviour,
  * see [[`GuKinesisLambdaProps`]].
+ *
+ * @alpha This pattern is in early development. The API is likely to change in future releases.
  */
 export class GuKinesisLambda extends GuLambdaFunction {
   constructor(scope: GuStack, id: string, props: GuKinesisLambdaProps) {

diff --git a/src/patterns/sns-lambda.ts b/src/patterns/sns-lambda.ts
@@ -77,6 +77,8 @@ export interface GuSnsLambdaProps extends Omit<GuFunctionProps, "errorPercentage
  * This pattern will create a new SNS topic by default. If you are migrating a stack from CloudFormation,
  * you will need to opt-out of this behaviour. For information on overriding the default behaviour,
  * see [[`GuSnsLambdaProps`]].
+ *
+ * @alpha This pattern is in early development. The API is likely to change in future releases.
  */
 export class GuSnsLambda extends GuLambdaFunction {
   constructor(scope: GuStack, id: string, props: GuSnsLambdaProps) {