@aws-solutions-constructs/aws-apigateway-sagemakerendpoint 2.85.2 → 2.85.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -8,7 +8,7 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "@aws-solutions-constructs/core": "2.85.2",
11
+ "@aws-solutions-constructs/core": "2.85.3",
12
12
  "aws-cdk-lib": "^2.193.0",
13
13
  "constructs": "^10.0.0"
14
14
  },
@@ -3993,7 +3993,7 @@
3993
3993
  },
3994
3994
  "name": "@aws-solutions-constructs/aws-apigateway-sagemakerendpoint",
3995
3995
  "readme": {
3996
- "markdown": "# aws-apigateway-sagemakerendpoint module\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)\n\n> All classes are under active development and subject to non-backward compatible changes or removal in any\n> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.\n> This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_apigateway_sagemakerendpoint`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-apigateway-sagemakerendpoint`|\n|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.apigatewaysagemakerendpoint`|\n\n## Overview\n\nThis AWS Solutions Construct implements an Amazon API Gateway connected to an Amazon SageMaker endpoint pattern.\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n``` typescript\nimport { Construct } from 'constructs';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { ApiGatewayToSageMakerEndpoint, ApiGatewayToSageMakerEndpointProps } from '@aws-solutions-constructs/aws-apigateway-sagemakerendpoint';\n\n// Below is an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request\nconst requestTemplate = `\n{\n \"instances\": [\n # set( $user_id = $input.params(\"user_id\") )\n # set( $items = $input.params(\"items\") )\n # foreach( $item in $items.split(\",\") )\n # if( $foreach.hasNext ),#end\n {\"in0\": [$user_id], \"in1\": [$item]}\n $esc.newline\n # end\n ]\n}`\n\n// Replace 'my-endpoint' with your Sagemaker Inference Endpoint\nnew ApiGatewayToSageMakerEndpoint(this, 'test-apigw-sagemakerendpoint', {\n endpointName: 'my-endpoint',\n resourcePath: '{user_id}',\n requestMappingTemplate: requestTemplate\n});\n```\n\nPython\n``` python\nfrom aws_solutions_constructs.aws_apigateway_sagemakerendpoint import ApiGatewayToSageMakerEndpoint\nfrom aws_cdk import Stack\nfrom constructs import Construct\n\n# Below is an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request\nrequest_template = \"\"\"\n{\n \"instances\": [\n # set( $user_id = $input.params(\"user_id\") )\n # set( $items = $input.params(\"items\") )\n # foreach( $item in $items.split(\",\") )\n # if( $foreach.hasNext ),#end\n {\"in0\": [$user_id], \"in1\": [$item]}\n $esc.newline\n # end\n ]\n}\"\"\"\n\n# Replace 'my-endpoint' with your Sagemaker Inference Endpoint\nApiGatewayToSageMakerEndpoint(self, 'test-apigw-sagemakerendpoint',\n endpoint_name='my-endpoint',\n resource_path='{user_id}',\n request_mapping_template=request_template\n )\n```\n\nJava\n``` java\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awsconstructs.services.apigatewaysagemakerendpoint.*;\n\n// Create an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request\nfinal String requestTemplate = \"{\"\n + \"\\\"instances\\\": [\"\n + \"# set( $user_id = $input.params(\\\"user_id\\\") )\"\n + \"# set( $items = $input.params(\\\"items\\\") )\"\n + \"# foreach( $item in $items.split(\\\",\\\") )\"\n + \"# if( $foreach.hasNext ),#end\"\n + \"{\\\"in0\\\": [$user_id], \\\"in1\\\": [$item]}\"\n + \" $esc.newline\"\n + \"# end\"\n + \"]\"\n + \"}\";\n\n// Replace \"\"my-endpoint\"\" with your Sagemaker Inference Endpoint\nnew ApiGatewayToSageMakerEndpoint(this, \"ApiGatewayToSageMakerEndpointPattern\",\n new ApiGatewayToSageMakerEndpointProps.Builder()\n .endpointName(\"my-endpoint\")\n .resourcePath(\"{user_id}\")\n .requestMappingTemplate(requestTemplate)\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|apiGatewayProps?|[`api.RestApiProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApiProps.html)|Optional user-provided props to override the default props for the API Gateway.|\n|createUsagePlan?|boolean|Whether to create a Usage Plan attached to the API. Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true. @default - true (to match legacy behavior)|\n|apiGatewayExecutionRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|IAM Role used by API Gateway to invoke the SageMaker endpoint. If not specified, a default role is created with access to `endpointName`.|\n|endpointName|`string`|Name of the deployed SageMaker inference endpoint.|\n|resourceName?|`string`|Optional resource name where the GET method will be available.|\n|resourcePath|`string`|Resource path for the GET method. The variable defined here can be referenced in `requestMappingTemplate`.|\n|requestMappingTemplate|`string`|Mapping template to convert GET requests for the default `application/json` content-type received on the REST API to POST requests expected by the SageMaker endpoint.|\n|additionalRequestTemplates|`{ [contentType: string]: string; }`|Optional Request Templates for content-types other than `application/json`. Use the `requestMappingTemplate` property to set the request template for the `application/json` content-type.|\n|responseMappingTemplate?|`string`|Optional mapping template to convert responses received from the SageMaker endpoint.|\n|logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|apiGateway|[`api.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|\n|apiGatewayRole|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway.|\n|apiGatewayCloudWatchRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.|\n|apiGatewayLogGroup|[`logs.LogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html)|Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.|\n\n## Sample API Usage\n\n> **Note**: Each SageMaker endpoint is unique, and the response from the API will depend on the deployed model. The example given below assumes the sample from [this blog post](https://aws.amazon.com/blogs/machine-learning/creating-a-machine-learning-powered-rest-api-with-amazon-api-gateway-mapping-templates-and-amazon-sagemaker/). For a reference on how that'd be implemented, please refer to [integ.apigateway-sagemakerendpoint-overwrite.ts](test/integ.apigateway-sagemakerendpoint-overwrite.ts).\n\n| **Method** | **Request Path** | **Query String** | **SageMaker Action** | **Description** |\n|:-------------|:----------------|-----------------|-----------------|-----------------|\n|GET|`/321`| `items=101,131,162` |`sagemaker:InvokeEndpoint`|Retrieves the predictions for a specific user and items.|\n\n## Default settings\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### Amazon API Gateway\n* Deploy an edge-optimized API endpoint\n* Enable CloudWatch logging for API Gateway\n* Configure least privilege access IAM role for API Gateway\n* Set the default authorizationType for all API methods to IAM\n* Enable X-Ray Tracing\n* Validate request parameters before passing data to SageMaker\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved."
3996
+ "markdown": "Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-apigateway-sagemakerendpoint/README.adoc)\n"
3997
3997
  },
3998
3998
  "repository": {
3999
3999
  "directory": "source/patterns/@aws-solutions-constructs/aws-apigateway-sagemakerendpoint",
@@ -4325,6 +4325,6 @@
4325
4325
  "symbolId": "lib/index:ApiGatewayToSageMakerEndpointProps"
4326
4326
  }
4327
4327
  },
4328
- "version": "2.85.2",
4329
- "fingerprint": "TBaVMCxcL5Z/AkfIuoNuFNI+i0DDS2WYM4P5fAcMo3w="
4328
+ "version": "2.85.3",
4329
+ "fingerprint": "Rj3s6u6Nc3xQks8GrYOqszjNlIMfuAU2xmNOm5t0uf8="
4330
4330
  }
package/README.adoc ADDED
@@ -0,0 +1,260 @@
1
+ //!!NODE_ROOT <section>
2
+ //== aws-apigateway-sagemakerendpoint module
3
+
4
+ [.topic]
5
+ = aws-apigateway-sagemakerendpoint
6
+ :info_doctype: section
7
+ :info_title: aws-apigateway-sagemakerendpoint
8
+
9
+
10
+ image:https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge[Stability:Experimental]
11
+
12
+ ____
13
+ All classes are under active development and subject to non-backward
14
+ compatible changes or removal in any future version. These are not
15
+ subject to the https://semver.org/[Semantic Versioning] model. This
16
+ means that while you may use them, you may need to update your source
17
+ code when upgrading to a newer version of this package.
18
+ ____
19
+
20
+ [width="100%",cols="<50%,<50%",options="header",]
21
+ |===
22
+ |*Reference Documentation*:
23
+ |https://docs.aws.amazon.com/solutions/latest/constructs/
24
+ |===
25
+
26
+ [width="100%",cols="<46%,54%",options="header",]
27
+ |===
28
+ |*Language* |*Package*
29
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/python32.png[Python
30
+ Logo] Python
31
+ |`aws_solutions_constructs.aws_apigateway_sagemakerendpoint`
32
+
33
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png[Typescript
34
+ Logo] Typescript
35
+ |`@aws-solutions-constructs/aws-apigateway-sagemakerendpoint`
36
+
37
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/java32.png[Java
38
+ Logo] Java
39
+ |`software.amazon.awsconstructs.services.apigatewaysagemakerendpoint`
40
+ |===
41
+
42
+ == Overview
43
+
44
+ This AWS Solutions Construct implements an Amazon API Gateway connected
45
+ to an Amazon SageMaker endpoint pattern.
46
+
47
+ Here is a minimal deployable pattern definition:
48
+
49
+ ====
50
+ [role="tablist"]
51
+ Typescript::
52
+ +
53
+ [source,typescript]
54
+ ----
55
+ import { Construct } from 'constructs';
56
+ import { Stack, StackProps } from 'aws-cdk-lib';
57
+ import { ApiGatewayToSageMakerEndpoint, ApiGatewayToSageMakerEndpointProps } from '@aws-solutions-constructs/aws-apigateway-sagemakerendpoint';
58
+
59
+ // Below is an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request
60
+ const requestTemplate = `
61
+ {
62
+ "instances": [
63
+ # set( $user_id = $input.params("user_id") )
64
+ # set( $items = $input.params("items") )
65
+ # foreach( $item in $items.split(",") )
66
+ # if( $foreach.hasNext ),#end
67
+ {"in0": [$user_id], "in1": [$item]}
68
+ $esc.newline
69
+ # end
70
+ ]
71
+ }`
72
+
73
+ // Replace 'my-endpoint' with your Sagemaker Inference Endpoint
74
+ new ApiGatewayToSageMakerEndpoint(this, 'test-apigw-sagemakerendpoint', {
75
+ endpointName: 'my-endpoint',
76
+ resourcePath: '{user_id}',
77
+ requestMappingTemplate: requestTemplate
78
+ });
79
+ ----
80
+
81
+ Python::
82
+ +
83
+ [source,python]
84
+ ----
85
+ from aws_solutions_constructs.aws_apigateway_sagemakerendpoint import ApiGatewayToSageMakerEndpoint
86
+ from aws_cdk import Stack
87
+ from constructs import Construct
88
+
89
+ # Below is an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request
90
+ request_template = """
91
+ {
92
+ "instances": [
93
+ # set( $user_id = $input.params("user_id") )
94
+ # set( $items = $input.params("items") )
95
+ # foreach( $item in $items.split(",") )
96
+ # if( $foreach.hasNext ),#end
97
+ {"in0": [$user_id], "in1": [$item]}
98
+ $esc.newline
99
+ # end
100
+ ]
101
+ }"""
102
+
103
+ # Replace 'my-endpoint' with your Sagemaker Inference Endpoint
104
+ ApiGatewayToSageMakerEndpoint(self, 'test-apigw-sagemakerendpoint',
105
+ endpoint_name='my-endpoint',
106
+ resource_path='{user_id}',
107
+ request_mapping_template=request_template
108
+ )
109
+ ----
110
+
111
+ Java::
112
+ +
113
+ [source,java]
114
+ ----
115
+ import software.constructs.Construct;
116
+
117
+ import software.amazon.awscdk.Stack;
118
+ import software.amazon.awscdk.StackProps;
119
+ import software.amazon.awsconstructs.services.apigatewaysagemakerendpoint.*;
120
+
121
+ // Create an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request
122
+ final String requestTemplate = "{"
123
+ + "\"instances\": ["
124
+ + "# set( $user_id = $input.params(\"user_id\") )"
125
+ + "# set( $items = $input.params(\"items\") )"
126
+ + "# foreach( $item in $items.split(\",\") )"
127
+ + "# if( $foreach.hasNext ),#end"
128
+ + "{\"in0\": [$user_id], \"in1\": [$item]}"
129
+ + " $esc.newline"
130
+ + "# end"
131
+ + "]"
132
+ + "}";
133
+
134
+ // Replace ""my-endpoint"" with your Sagemaker Inference Endpoint
135
+ new ApiGatewayToSageMakerEndpoint(this, "ApiGatewayToSageMakerEndpointPattern",
136
+ new ApiGatewayToSageMakerEndpointProps.Builder()
137
+ .endpointName("my-endpoint")
138
+ .resourcePath("{user_id}")
139
+ .requestMappingTemplate(requestTemplate)
140
+ .build());
141
+ ----
142
+ ====
143
+
144
+ == Pattern Construct Props
145
+
146
+ [width="100%",cols="<30%,<35%,35%",options="header",]
147
+ |===
148
+ |*Name* |*Type* |*Description*
149
+ |apiGatewayProps?
150
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApiProps.html[`api.RestApiProps`]
151
+ |Optional user-provided props to override the default props for the API
152
+ Gateway.
153
+
154
+ |createUsagePlan? |boolean |Whether to create a Usage Plan attached to
155
+ the API. Must be true if
156
+ apiGatewayProps.defaultMethodOptions.apiKeyRequired is true. @default -
157
+ true (to match legacy behavior)
158
+
159
+ |apiGatewayExecutionRole?
160
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html[`iam.Role`]
161
+ |IAM Role used by API Gateway to invoke the SageMaker endpoint. If not
162
+ specified, a default role is created with access to `endpointName`.
163
+
164
+ |endpointName |`string` |Name of the deployed SageMaker inference
165
+ endpoint.
166
+
167
+ |resourceName? |`string` |Optional resource name where the GET method
168
+ will be available.
169
+
170
+ |resourcePath |`string` |Resource path for the GET method. The variable
171
+ defined here can be referenced in `requestMappingTemplate`.
172
+
173
+ |requestMappingTemplate |`string` |Mapping template to convert GET
174
+ requests for the default `application/json` content-type received on the
175
+ REST API to POST requests expected by the SageMaker endpoint.
176
+
177
+ |additionalRequestTemplates
178
+ |`{ [contentType: string]: string; }` |Optional Request
179
+ Templates for content-types other than `application/json`. Use the
180
+ `requestMappingTemplate` property to set the request template for the
181
+ `application/json` content-type.
182
+
183
+ |responseMappingTemplate? |`string` |Optional mapping template to
184
+ convert responses received from the SageMaker endpoint.
185
+
186
+ |logGroupProps?
187
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html[`logs.LogGroupProps`]
188
+ |User provided props to override the default props for for the
189
+ CloudWatchLogs LogGroup.
190
+ |===
191
+
192
+ == Pattern Properties
193
+
194
+ [width="100%",cols="<30%,<35%,35%",options="header",]
195
+ |===
196
+ |*Name* |*Type* |*Description*
197
+ |apiGateway
198
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html[`api.RestApi`]
199
+ |Returns an instance of the API Gateway REST API created by the pattern.
200
+
201
+ |apiGatewayRole
202
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html[`iam.Role`]
203
+ |Returns an instance of the iam.Role created by the construct for API
204
+ Gateway.
205
+
206
+ |apiGatewayCloudWatchRole?
207
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html[`iam.Role`]
208
+ |Returns an instance of the iam.Role created by the construct for API
209
+ Gateway for CloudWatch access.
210
+
211
+ |apiGatewayLogGroup
212
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html[`logs.LogGroup`]
213
+ |Returns an instance of the LogGroup created by the construct for API
214
+ Gateway access logging to CloudWatch.
215
+ |===
216
+
217
+ == Sample API Usage
218
+
219
+ ____
220
+ *Note*: Each SageMaker endpoint is unique, and the response from the API
221
+ will depend on the deployed model. The example given below assumes the
222
+ sample from
223
+ https://aws.amazon.com/blogs/machine-learning/creating-a-machine-learning-powered-rest-api-with-amazon-api-gateway-mapping-templates-and-amazon-sagemaker/[this
224
+ blog post]. For a reference on how that’d be implemented, please refer
225
+ to
226
+ link:test/integ.apigateway-sagemakerendpoint-overwrite.ts[integ.apigateway-sagemakerendpoint-overwrite.ts].
227
+ ____
228
+
229
+ [width="99%",cols="<20%,<20%,20%,20%,20%",options="header",]
230
+ |===
231
+ |*Method* |*Request Path* |*Query String* |*SageMaker Action*
232
+ |*Description*
233
+ |GET |`/321` |`items=101,131,162` |`sagemaker:InvokeEndpoint` |Retrieves
234
+ the predictions for a specific user and items.
235
+ |===
236
+
237
+ == Default settings
238
+
239
+ Out of the box implementation of the Construct without any override will
240
+ set the following defaults:
241
+
242
+ === Amazon API Gateway
243
+
244
+ * Deploy an edge-optimized API endpoint
245
+ * Enable CloudWatch logging for API Gateway
246
+ * Configure least privilege access IAM role for API Gateway
247
+ * Set the default authorizationType for all API methods to IAM
248
+ * Enable X-Ray Tracing
249
+ * Validate request parameters before passing data to SageMaker
250
+
251
+ == Architecture
252
+
253
+
254
+ image::aws-apigateway-sagemakerendpoint.png["Diagram showing Amazon CloudWatch, API Gateway, SageMaker AI endpoint, and IAM roles connections.",scaledwidth=100%]
255
+
256
+ // github block
257
+
258
+ '''''
259
+
260
+ © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
package/README.md CHANGED
@@ -1,164 +1 @@
1
- # aws-apigateway-sagemakerendpoint module
2
- <!--BEGIN STABILITY BANNER-->
3
-
4
- ---
5
-
6
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
7
-
8
- > All classes are under active development and subject to non-backward compatible changes or removal in any
9
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
10
- > This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
11
-
12
- ---
13
- <!--END STABILITY BANNER-->
14
-
15
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
16
- |:-------------|:-------------|
17
- <div style="height:8px"></div>
18
-
19
- | **Language** | **Package** |
20
- |:-------------|-----------------|
21
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_apigateway_sagemakerendpoint`|
22
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-apigateway-sagemakerendpoint`|
23
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.apigatewaysagemakerendpoint`|
24
-
25
- ## Overview
26
-
27
- This AWS Solutions Construct implements an Amazon API Gateway connected to an Amazon SageMaker endpoint pattern.
28
-
29
- Here is a minimal deployable pattern definition:
30
-
31
- Typescript
32
- ``` typescript
33
- import { Construct } from 'constructs';
34
- import { Stack, StackProps } from 'aws-cdk-lib';
35
- import { ApiGatewayToSageMakerEndpoint, ApiGatewayToSageMakerEndpointProps } from '@aws-solutions-constructs/aws-apigateway-sagemakerendpoint';
36
-
37
- // Below is an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request
38
- const requestTemplate = `
39
- {
40
- "instances": [
41
- # set( $user_id = $input.params("user_id") )
42
- # set( $items = $input.params("items") )
43
- # foreach( $item in $items.split(",") )
44
- # if( $foreach.hasNext ),#end
45
- {"in0": [$user_id], "in1": [$item]}
46
- $esc.newline
47
- # end
48
- ]
49
- }`
50
-
51
- // Replace 'my-endpoint' with your Sagemaker Inference Endpoint
52
- new ApiGatewayToSageMakerEndpoint(this, 'test-apigw-sagemakerendpoint', {
53
- endpointName: 'my-endpoint',
54
- resourcePath: '{user_id}',
55
- requestMappingTemplate: requestTemplate
56
- });
57
- ```
58
-
59
- Python
60
- ``` python
61
- from aws_solutions_constructs.aws_apigateway_sagemakerendpoint import ApiGatewayToSageMakerEndpoint
62
- from aws_cdk import Stack
63
- from constructs import Construct
64
-
65
- # Below is an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request
66
- request_template = """
67
- {
68
- "instances": [
69
- # set( $user_id = $input.params("user_id") )
70
- # set( $items = $input.params("items") )
71
- # foreach( $item in $items.split(",") )
72
- # if( $foreach.hasNext ),#end
73
- {"in0": [$user_id], "in1": [$item]}
74
- $esc.newline
75
- # end
76
- ]
77
- }"""
78
-
79
- # Replace 'my-endpoint' with your Sagemaker Inference Endpoint
80
- ApiGatewayToSageMakerEndpoint(self, 'test-apigw-sagemakerendpoint',
81
- endpoint_name='my-endpoint',
82
- resource_path='{user_id}',
83
- request_mapping_template=request_template
84
- )
85
- ```
86
-
87
- Java
88
- ``` java
89
- import software.constructs.Construct;
90
-
91
- import software.amazon.awscdk.Stack;
92
- import software.amazon.awscdk.StackProps;
93
- import software.amazon.awsconstructs.services.apigatewaysagemakerendpoint.*;
94
-
95
- // Create an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request
96
- final String requestTemplate = "{"
97
- + "\"instances\": ["
98
- + "# set( $user_id = $input.params(\"user_id\") )"
99
- + "# set( $items = $input.params(\"items\") )"
100
- + "# foreach( $item in $items.split(\",\") )"
101
- + "# if( $foreach.hasNext ),#end"
102
- + "{\"in0\": [$user_id], \"in1\": [$item]}"
103
- + " $esc.newline"
104
- + "# end"
105
- + "]"
106
- + "}";
107
-
108
- // Replace ""my-endpoint"" with your Sagemaker Inference Endpoint
109
- new ApiGatewayToSageMakerEndpoint(this, "ApiGatewayToSageMakerEndpointPattern",
110
- new ApiGatewayToSageMakerEndpointProps.Builder()
111
- .endpointName("my-endpoint")
112
- .resourcePath("{user_id}")
113
- .requestMappingTemplate(requestTemplate)
114
- .build());
115
- ```
116
-
117
- ## Pattern Construct Props
118
-
119
- | **Name** | **Type** | **Description** |
120
- |:-------------|:----------------|-----------------|
121
- |apiGatewayProps?|[`api.RestApiProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApiProps.html)|Optional user-provided props to override the default props for the API Gateway.|
122
- |createUsagePlan?|boolean|Whether to create a Usage Plan attached to the API. Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true. @default - true (to match legacy behavior)|
123
- |apiGatewayExecutionRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|IAM Role used by API Gateway to invoke the SageMaker endpoint. If not specified, a default role is created with access to `endpointName`.|
124
- |endpointName|`string`|Name of the deployed SageMaker inference endpoint.|
125
- |resourceName?|`string`|Optional resource name where the GET method will be available.|
126
- |resourcePath|`string`|Resource path for the GET method. The variable defined here can be referenced in `requestMappingTemplate`.|
127
- |requestMappingTemplate|`string`|Mapping template to convert GET requests for the default `application/json` content-type received on the REST API to POST requests expected by the SageMaker endpoint.|
128
- |additionalRequestTemplates|`{ [contentType: string]: string; }`|Optional Request Templates for content-types other than `application/json`. Use the `requestMappingTemplate` property to set the request template for the `application/json` content-type.|
129
- |responseMappingTemplate?|`string`|Optional mapping template to convert responses received from the SageMaker endpoint.|
130
- |logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|
131
-
132
- ## Pattern Properties
133
-
134
- | **Name** | **Type** | **Description** |
135
- |:-------------|:----------------|-----------------|
136
- |apiGateway|[`api.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|
137
- |apiGatewayRole|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway.|
138
- |apiGatewayCloudWatchRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.|
139
- |apiGatewayLogGroup|[`logs.LogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html)|Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.|
140
-
141
- ## Sample API Usage
142
-
143
- > **Note**: Each SageMaker endpoint is unique, and the response from the API will depend on the deployed model. The example given below assumes the sample from [this blog post](https://aws.amazon.com/blogs/machine-learning/creating-a-machine-learning-powered-rest-api-with-amazon-api-gateway-mapping-templates-and-amazon-sagemaker/). For a reference on how that'd be implemented, please refer to [integ.apigateway-sagemakerendpoint-overwrite.ts](test/integ.apigateway-sagemakerendpoint-overwrite.ts).
144
-
145
- | **Method** | **Request Path** | **Query String** | **SageMaker Action** | **Description** |
146
- |:-------------|:----------------|-----------------|-----------------|-----------------|
147
- |GET|`/321`| `items=101,131,162` |`sagemaker:InvokeEndpoint`|Retrieves the predictions for a specific user and items.|
148
-
149
- ## Default settings
150
- Out of the box implementation of the Construct without any override will set the following defaults:
151
-
152
- ### Amazon API Gateway
153
- * Deploy an edge-optimized API endpoint
154
- * Enable CloudWatch logging for API Gateway
155
- * Configure least privilege access IAM role for API Gateway
156
- * Set the default authorizationType for all API methods to IAM
157
- * Enable X-Ray Tracing
158
- * Validate request parameters before passing data to SageMaker
159
-
160
- ## Architecture
161
- ![Architecture Diagram](architecture.png)
162
-
163
- ***
164
- &copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
1
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-apigateway-sagemakerendpoint/README.adoc)
package/lib/index.js CHANGED
@@ -116,5 +116,5 @@ class ApiGatewayToSageMakerEndpoint extends constructs_1.Construct {
116
116
  }
117
117
  exports.ApiGatewayToSageMakerEndpoint = ApiGatewayToSageMakerEndpoint;
118
118
  _a = JSII_RTTI_SYMBOL_1;
119
- ApiGatewayToSageMakerEndpoint[_a] = { fqn: "@aws-solutions-constructs/aws-apigateway-sagemakerendpoint.ApiGatewayToSageMakerEndpoint", version: "2.85.2" };
119
+ ApiGatewayToSageMakerEndpoint[_a] = { fqn: "@aws-solutions-constructs/aws-apigateway-sagemakerendpoint.ApiGatewayToSageMakerEndpoint", version: "2.85.3" };
120
120
  //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAAA;;;;;;;;;;;GAWG;AAEH,UAAU;AACV,2CAAuC;AAEvC,2CAA2C;AAC3C,2DAA2D;AAC3D,6CAAkC;AAwElC;;GAEG;AACH,MAAa,6BAA8B,SAAQ,sBAAS;IAM1D;;;;;;;OAOG;IACH,YAAY,KAAgB,EAAE,EAAU,EAAE,KAAyC;QACjF,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjB,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9B,6FAA6F;QAE7F,wBAAwB;QACxB,MAAM,qBAAqB,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9H,IAAI,CAAC,UAAU,GAAG,qBAAqB,CAAC,GAAG,CAAC;QAC5C,IAAI,CAAC,wBAAwB,GAAG,qBAAqB,CAAC,IAAI,CAAC;QAC3D,IAAI,CAAC,kBAAkB,GAAI,qBAAqB,CAAC,QAAQ,CAAC;QAE1D,6BAA6B;QAC7B,IAAI,KAAK,CAAC,uBAAuB,KAAK,SAAS,EAAE,CAAC;YAChD,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,uBAAuB,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE;gBAC3D,SAAS,EAAE,IAAI,GAAG,CAAC,gBAAgB,CAAC,0BAA0B,CAAC;aAChE,CAAC,CAAC;YACH,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,4BAA4B,CAAC,CAAC,CAAC;YAEvF,8CAA8C;YAC9C,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE;gBAChE,UAAU,EAAE;oBACV,IAAI,GAAG,CAAC,eAAe,CAAC;wBACtB,OAAO,EAAE,CAAC,0BAA0B,CAAC;wBACrC,SAAS,EAAE,CAAC,OAAO,iBAAG,CAAC,SAAS,cAAc,iBAAG,CAAC,MAAM,IAAI,iBAAG,CAAC,UAAU,aAAa,KAAK,CAAC,YAAY,EAAE,CAAC;qBAC7G,CAAC;iBACH;aACF,CAAC,CAAC;YAEH,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACjD,CAAC;QAED,2BAA2B;QAC3B,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,mBAAmB,EAAE;YAChF,oBAAoB,EAAE,yBAAyB;YAE/C,wEAAwE;YACxE,2CAA2C;YAC3C,iBAAiB;YACjB,YAAY;YACZ,yBAAyB,EAAE,IAAI;SAChC,CAAC,CAAC;QAEH,yCAAyC;QACzC,MAAM,eAAe,GAAyB;YAC5C,EAAE,UAAU,EAAE,KAAK,EAAE;YACrB,EAAE,UAAU,EAAE,KAAK,EAAE;YACrB,EAAE,UAAU,EAAE,KAAK,EAAE;SACtB,CAAC;QAEF,MAAM,cAAc,GAA8B,EAAE,CAAC;QACrD,IAAI,KAAK,CAAC,uBAAuB,KAAK,SAAS,EAAE,CAAC;YAChD,cAAc,CAAC,IAAI,CAAC;gBAClB,UAAU,EAAE,KAAK;gBACjB,iBAAiB,EAAE,EAAE,kBAAkB,EAAE,KAAK,CAAC,uBAAuB,EAAE;aACzE,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,cAAc,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7C,CAAC;QAED,cAAc,CAAC,IAAI,CACjB,EAAE,UAAU,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,EAClD,EAAE,UAAU,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,CACnD,CAAC;QAEF,6HAA6H;QAC7H,uFAAuF;QACvF,+EAA+E;QAC/E,IAAI,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QACvC,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACrC,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5D,CAAC;QACD,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAE1D,2BAA2B;QAC3B,QAAQ,CAAC,2BAA2B,CAAC;YACnC,OAAO,EAAE,mBAAmB;YAC5B,IAAI,EAAE,aAAa,KAAK,CAAC,YAAY,cAAc;YACnD,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,SAAS,EAAE,KAAK;YAChB,WAAW;YACX,eAAe,EAAE,KAAK,CAAC,sBAAsB;YAC7C,0BAA0B,EAAE,KAAK,CAAC,0BAA0B;YAC5D,mBAAmB,EAAE;gBACnB,OAAO,EAAE,EAAE,oBAAoB,EAAE,cAAc,EAAE;aAClD;YACD,aAAa,EAAE;gBACb,eAAe;gBACf,gBAAgB;aACjB;SACF,CAAC,CAAC;IACL,CAAC;;AA1GH,sEA2GC","sourcesContent":["/**\n *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n *\n *  Licensed under the Apache License, Version 2.0 (the \"License\"). You may not use this file except in compliance\n *  with the License. A copy of the License is located at\n *\n *      http://www.apache.org/licenses/LICENSE-2.0\n *\n *  or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES\n *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions\n *  and limitations under the License.\n */\n\n// Imports\nimport { Construct } from 'constructs';\nimport * as api from 'aws-cdk-lib/aws-apigateway';\nimport * as iam from 'aws-cdk-lib/aws-iam';\nimport * as defaults from '@aws-solutions-constructs/core';\nimport { Aws } from 'aws-cdk-lib';\nimport * as logs from 'aws-cdk-lib/aws-logs';\n\n/**\n * @summary The properties for the ApiGatewayToSageMakerEndpointProps class.\n */\nexport interface ApiGatewayToSageMakerEndpointProps {\n  /**\n   * Optional user-provided props to override the default props for the API Gateway.\n   *\n   * @default - Default properties are used.\n   */\n  readonly apiGatewayProps?: api.RestApiProps,\n  /**\n   * Whether to create a Usage Plan attached to the API. Must be true if\n   * apiGatewayProps.defaultMethodOptions.apiKeyRequired is true\n   *\n   * @default - true (to match legacy behavior)\n   */\n  readonly createUsagePlan?: boolean\n  /**\n   * Optional IAM role that is used by API Gateway to invoke the SageMaker endpoint.\n   *\n   * @default - An IAM role with sagemaker:InvokeEndpoint access to `endpointName` is created.\n   */\n  readonly apiGatewayExecutionRole?: iam.Role,\n  /**\n   * Name of the deployed SageMaker inference endpoint.\n   *\n   * @default - None.\n   */\n  readonly endpointName: string,\n  /**\n   * Optional resource name where the GET method will be available.\n   *\n   * @default - None.\n   */\n  readonly resourceName?: string,\n  /**\n   * Resource path for the GET method. The variable defined here can be referenced in `requestMappingTemplate`.\n   *\n   * @default - None.\n   */\n  readonly resourcePath: string,\n  /**\n   * Mapping template to convert GET requests for the default `application/json` content-type received\n   * on the REST API to POST requests expected by the SageMaker endpoint.\n   *\n   * @default - None.\n   */\n  readonly requestMappingTemplate: string,\n  /**\n   * Optional Request Templates for content-types other than `application/json`.\n   * Use the `requestMappingTemplate` property to set the request template for the `application/json` content-type.\n   *\n   * @default - None\n   */\n  readonly additionalRequestTemplates?: { [contentType: string]: string; };\n  /**\n   * Optional mapping template to convert responses received from the SageMaker endpoint.\n   *\n   * @default - None.\n   */\n  readonly responseMappingTemplate?: string,\n  /**\n   * User provided props to override the default props for the CloudWatchLogs LogGroup.\n   *\n   * @default - Default props are used\n   */\n  readonly logGroupProps?: logs.LogGroupProps\n}\n\n/**\n * @summary The ApiGatewayToSageMakerEndpoint class.\n */\nexport class ApiGatewayToSageMakerEndpoint extends Construct {\n  public readonly apiGateway: api.RestApi;\n  public readonly apiGatewayRole: iam.Role;\n  public readonly apiGatewayCloudWatchRole?: iam.Role;\n  public readonly apiGatewayLogGroup: logs.LogGroup;\n\n  /**\n   * @summary Constructs a new instance of the ApiGatewayToSageMakerEndpoint class.\n   * @param {cdk.App} scope - represents the scope for all the resources.\n   * @param {string} id - this is a a scope-unique id.\n   * @param {ApiGatewayToSageMakerEndpointProps} props - user provided props for the construct.\n   * @since 1.68.0\n   * @access public\n   */\n  constructor(scope: Construct, id: string, props: ApiGatewayToSageMakerEndpointProps) {\n    super(scope, id);\n    defaults.CheckApiProps(props);\n    // CheckSagemakerProps is not called because this construct can't create a Sagemaker resource\n\n    // Setup the API Gateway\n    const globalRestApiResponse = defaults.GlobalRestApi(this, props.apiGatewayProps, props.logGroupProps, props.createUsagePlan);\n    this.apiGateway = globalRestApiResponse.api;\n    this.apiGatewayCloudWatchRole = globalRestApiResponse.role;\n    this.apiGatewayLogGroup =  globalRestApiResponse.logGroup;\n\n    // Setup the API Gateway role\n    if (props.apiGatewayExecutionRole !== undefined) {\n      this.apiGatewayRole = props.apiGatewayExecutionRole;\n    } else {\n      this.apiGatewayRole = new iam.Role(this, 'api-gateway-role', {\n        assumedBy: new iam.ServicePrincipal('apigateway.amazonaws.com')\n      });\n      defaults.addCfnGuardSuppressRules(this.apiGatewayRole, [\"IAM_NO_INLINE_POLICY_CHECK\"]);\n\n      // Setup the IAM policy for SageMaker endpoint\n      const invokePolicy = new iam.Policy(this, 'InvokeEndpointPolicy', {\n        statements: [\n          new iam.PolicyStatement({\n            actions: ['sagemaker:InvokeEndpoint'],\n            resources: [`arn:${Aws.PARTITION}:sagemaker:${Aws.REGION}:${Aws.ACCOUNT_ID}:endpoint/${props.endpointName}`]\n          })\n        ]\n      });\n\n      invokePolicy.attachToRole(this.apiGatewayRole);\n    }\n\n    // Setup request validation\n    const requestValidator = this.apiGateway.addRequestValidator('request-validator', {\n      requestValidatorName: 'request-param-validator',\n\n      // Setting this property to true makes sure the following are validated:\n      // - Required request parameters in the URI\n      // - Query string\n      // - Headers\n      validateRequestParameters: true\n    });\n\n    // Setup method and integration responses\n    const methodResponses: api.MethodResponse[] = [\n      { statusCode: '200' },\n      { statusCode: '500' },\n      { statusCode: '400' }\n    ];\n\n    const integResponses: api.IntegrationResponse[] = [];\n    if (props.responseMappingTemplate !== undefined) {\n      integResponses.push({\n        statusCode: '200',\n        responseTemplates: { 'application/json': props.responseMappingTemplate }\n      });\n    } else {\n      integResponses.push({ statusCode: '200' });\n    }\n\n    integResponses.push(\n      { statusCode: '500', selectionPattern: '5\\\\d{2}' },\n      { statusCode: '400', selectionPattern: '4\\\\d{2}' }\n    );\n\n    // The SageMaker integration can be added either at the root of the API (GET https://execute-api.amazonaws.com/{some-param}),\n    // or as a sub-resource (GET https://execute-api.amazonaws.com/inference/{some-param}).\n    // The following lines will make sure only the necessary resources are created.\n    let apiResource = this.apiGateway.root;\n    if (props.resourceName !== undefined) {\n      apiResource = apiResource.addResource(props.resourceName);\n    }\n    apiResource = apiResource.addResource(props.resourcePath);\n\n    // Setup API Gateway method\n    defaults.addProxyMethodToApiResource({\n      service: 'runtime.sagemaker',\n      path: `endpoints/${props.endpointName}/invocations`,\n      apiGatewayRole: this.apiGatewayRole,\n      apiMethod: 'GET',\n      apiResource,\n      requestTemplate: props.requestMappingTemplate,\n      additionalRequestTemplates: props.additionalRequestTemplates,\n      awsIntegrationProps: {\n        options: { integrationResponses: integResponses }\n      },\n      methodOptions: {\n        methodResponses,\n        requestValidator,\n      }\n    });\n  }\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-solutions-constructs/aws-apigateway-sagemakerendpoint",
3
- "version": "2.85.2",
3
+ "version": "2.85.3",
4
4
  "description": "CDK Constructs for AWS API Gateway and Amazon SageMaker Endpoint integration.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -22,12 +22,13 @@
22
22
  "test": "jest --coverage",
23
23
  "clean": "tsc -b --clean",
24
24
  "watch": "tsc -b -w",
25
+ "asciidoc": "asciidoctor --failure-level WARNING -o /dev/null README.adoc",
25
26
  "integ": "integ-runner --update-on-failed",
26
27
  "integ-no-clean": "integ-runner --update-on-failed --no-clean",
27
28
  "integ-assert": "integ-runner",
28
29
  "jsii": "jsii",
29
30
  "jsii-pacmak": "jsii-pacmak",
30
- "build+lint+test": "npm run jsii && npm run lint && npm test && npm run integ-assert",
31
+ "build+lint+test": "npm run jsii && npm run lint && npm run asciidoc && npm test && npm run integ-assert",
31
32
  "blt": "npm run build+lint+test",
32
33
  "snapshot-update": "npm run jsii && npm test -- -u && npm run integ-assert"
33
34
  },
@@ -54,7 +55,7 @@
54
55
  }
55
56
  },
56
57
  "dependencies": {
57
- "@aws-solutions-constructs/core": "2.85.2",
58
+ "@aws-solutions-constructs/core": "2.85.3",
58
59
  "constructs": "^10.0.0"
59
60
  },
60
61
  "devDependencies": {
@@ -79,7 +80,7 @@
79
80
  ]
80
81
  },
81
82
  "peerDependencies": {
82
- "@aws-solutions-constructs/core": "2.85.2",
83
+ "@aws-solutions-constructs/core": "2.85.3",
83
84
  "constructs": "^10.0.0",
84
85
  "aws-cdk-lib": "^2.193.0"
85
86
  },