Skip to content

Commit 951b8aa

Browse files
fix(deprecation): announce deprecation of some constructs (#794)
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
1 parent 0ab6ee8 commit 951b8aa

File tree

3 files changed

+17
-1
lines changed

3 files changed

+17
-1
lines changed

apidocs/classes/WebCrawler.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ user provided props for the construct.
4040

4141
0.0.0
4242

43+
#### Deprecated
44+
45+
This construct is deprecated and will be removed in a future major version.
46+
It will not receive security updates.
47+
4348
#### Overrides
4449

4550
[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructors)

src/patterns/gen-ai/aws-rag-appsync-stepfn-kendra/index.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
*/
1313
import * as path from 'path';
1414
import * as cdk from 'aws-cdk-lib';
15-
import { Duration, RemovalPolicy } from 'aws-cdk-lib';
15+
import { Duration, RemovalPolicy, Annotations } from 'aws-cdk-lib';
1616
import * as appsync from 'aws-cdk-lib/aws-appsync';
1717
import * as cognito from 'aws-cdk-lib/aws-cognito';
1818
import { Table } from 'aws-cdk-lib/aws-dynamodb';
@@ -176,10 +176,15 @@ export class RagAppsyncStepfnKendra extends BaseClass {
176176
* @param {RagAppsyncStepfnKendraProps} props - user provided props for the construct.
177177
* @since 0.0.0
178178
* @access public
179+
* @deprecated This construct is deprecated and will be removed in a future major version.
180+
* It will not receive security updates.
179181
*/
180182
constructor(scope: Construct, id: string, props: RagAppsyncStepfnKendraProps) {
181183
super(scope, id);
182184

185+
Annotations.of(scope).addWarningV2('@cdklabs/generative-ai-cdk-constructs:RagAppsyncStepfnKendra.deprecation',
186+
'This construct is deprecated and will not receive further support. It will be removed in the next release of the library.');
187+
183188
const baseProps: BaseClassProps = {
184189
stage: props.stage,
185190
constructName: ConstructName.AWSRAGAPPSYNCSTEPFNKENDRA,

src/patterns/gen-ai/aws-web-crawler/index.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import * as crypto from 'crypto';
1414
import * as path from 'path';
1515
import * as url from 'url';
1616
import * as cdk from 'aws-cdk-lib';
17+
import { Annotations } from 'aws-cdk-lib';
1718
import * as batch from 'aws-cdk-lib/aws-batch';
1819
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
1920
import * as ec2 from 'aws-cdk-lib/aws-ec2';
@@ -183,10 +184,15 @@ export class WebCrawler extends BaseClass {
183184
* @param {WebCrawlerProps} props - user provided props for the construct.
184185
* @since 0.0.0
185186
* @public
187+
* @deprecated This construct is deprecated and will be removed in a future major version.
188+
* It will not receive security updates.
186189
*/
187190
constructor(scope: Construct, id: string, props: WebCrawlerProps) {
188191
super(scope, id);
189192

193+
Annotations.of(scope).addWarningV2('@cdklabs/generative-ai-cdk-constructs:WebCrawler.deprecation',
194+
'This construct is deprecated and will not receive further support. It will be removed in the next release of the library.');
195+
190196
vpc_helper.CheckVpcProps(props);
191197
s3_bucket_helper.CheckS3Props({
192198
existingBucketObj: props.existingOutputBucketObj,

0 commit comments

Comments
 (0)