aws-solutions-constructs.aws-lambda-kendra 2.85.2__tar.gz → 2.85.3__tar.gz

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.
Files changed (20) hide show
  1. aws_solutions_constructs_aws_lambda_kendra-2.85.3/PKG-INFO +28 -0
  2. aws_solutions_constructs_aws_lambda_kendra-2.85.3/README.md +1 -0
  3. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/setup.py +3 -3
  4. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs/aws_lambda_kendra/__init__.py +1 -138
  5. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs/aws_lambda_kendra/_jsii/__init__.py +2 -2
  6. aws_solutions_constructs_aws_lambda_kendra-2.85.3/src/aws_solutions_constructs/aws_lambda_kendra/_jsii/aws-lambda-kendra@2.85.3.jsii.tgz +0 -0
  7. aws_solutions_constructs_aws_lambda_kendra-2.85.3/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/PKG-INFO +28 -0
  8. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/SOURCES.txt +1 -1
  9. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/requires.txt +1 -1
  10. aws_solutions_constructs_aws_lambda_kendra-2.85.2/PKG-INFO +0 -165
  11. aws_solutions_constructs_aws_lambda_kendra-2.85.2/README.md +0 -138
  12. aws_solutions_constructs_aws_lambda_kendra-2.85.2/src/aws_solutions_constructs/aws_lambda_kendra/_jsii/aws-lambda-kendra@2.85.2.jsii.tgz +0 -0
  13. aws_solutions_constructs_aws_lambda_kendra-2.85.2/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/PKG-INFO +0 -165
  14. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/LICENSE +0 -0
  15. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/MANIFEST.in +0 -0
  16. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/pyproject.toml +0 -0
  17. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/setup.cfg +0 -0
  18. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs/aws_lambda_kendra/py.typed +0 -0
  19. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/dependency_links.txt +0 -0
  20. {aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/top_level.txt +0 -0
aws_solutions_constructs_aws_lambda_kendra-2.85.3/PKG-INFO ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-lambda-kendra
3
+ Version: 2.85.3
4
+ Summary: CDK constructs for defining an interaction between an AWS Lambda function and an existing Amazon Kinesis Firehose Delivery Stream.
5
+ Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
+ Author: Amazon Web Services
7
+ License: Apache-2.0
8
+ Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: JavaScript
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Typing :: Typed
17
+ Classifier: License :: OSI Approved
18
+ Requires-Python: ~=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
+ Requires-Dist: aws-solutions-constructs.core==2.85.3
23
+ Requires-Dist: constructs<11.0.0,>=10.0.0
24
+ Requires-Dist: jsii<2.0.0,>=1.111.0
25
+ Requires-Dist: publication>=0.0.3
26
+ Requires-Dist: typeguard<4.3.0,>=2.13.3
27
+
28
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-lambda-kendra/README.adoc)
aws_solutions_constructs_aws_lambda_kendra-2.85.3/README.md ADDED
@@ -0,0 +1 @@
1
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-lambda-kendra/README.adoc)
{aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/setup.py RENAMED
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "aws-solutions-constructs.aws-lambda-kendra",
8
- "version": "2.85.2",
8
+ "version": "2.85.3",
9
9
  "description": "CDK constructs for defining an interaction between an AWS Lambda function and an existing Amazon Kinesis Firehose Delivery Stream.",
10
10
  "license": "Apache-2.0",
11
11
  "url": "https://github.com/awslabs/aws-solutions-constructs.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
26
26
  ],
27
27
  "package_data": {
28
28
  "aws_solutions_constructs.aws_lambda_kendra._jsii": [
29
- "aws-lambda-kendra@2.85.2.jsii.tgz"
29
+ "aws-lambda-kendra@2.85.3.jsii.tgz"
30
30
  ],
31
31
  "aws_solutions_constructs.aws_lambda_kendra": [
32
32
  "py.typed"
@@ -35,7 +35,7 @@ kwargs = json.loads(
35
35
  "python_requires": "~=3.9",
36
36
  "install_requires": [
37
37
  "aws-cdk-lib>=2.193.0, <3.0.0",
38
- "aws-solutions-constructs.core==2.85.2",
38
+ "aws-solutions-constructs.core==2.85.3",
39
39
  "constructs>=10.0.0, <11.0.0",
40
40
  "jsii>=1.111.0, <2.0.0",
41
41
  "publication>=0.0.3",
{aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs/aws_lambda_kendra/__init__.py RENAMED
@@ -1,142 +1,5 @@
1
1
  r'''
2
- # aws-lambda-kendra module
3
-
4
- ---
5
-
6
-
7
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
8
-
9
- > All classes are under active development and subject to non-backward compatible changes or removal in any
10
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
11
- > 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.
12
-
13
- ---
14
-
15
-
16
- | **Reference Documentation**: | <span style="font-weight: normal;">https://docs.aws.amazon.com/solutions/latest/constructs/</span> |
17
- | --- | --- |
18
-
19
- | **Language** | **Package** |
20
- | --- | --- |
21
- | ![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python | `aws_solutions_constructs.aws_lambda_kendra` |
22
- | ![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript | `@aws-solutions-constructs/aws-lambda-kendra` |
23
- | ![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java | `software.amazon.awsconstructs.services.lambdakendra` |
24
-
25
- ## Overview
26
-
27
- This AWS Solutions Construct implements an AWS Lambda function and Amazon Kendra index with the least privileged permissions.
28
-
29
- Here is a minimal deployable pattern definition:
30
-
31
- Typescript
32
-
33
- ```python
34
- import { Construct } from 'constructs';
35
- import { Stack, StackProps, Aws } from 'aws-cdk-lib';
36
- import { LambdaToKendra } from '@aws-solutions-constructs/aws-lambda-kendra';
37
- import * as lambda from "aws-cdk-lib/aws-lambda";
38
- import * as s3 from "aws-cdk-lib/aws-s3";
39
-
40
- const lambdaProps: lambda.FunctionProps = {
41
- code: lambda.Code.fromAsset(`lambda`),
42
- runtime: lambda.Runtime.NODEJS_20_X,
43
- handler: 'index.handler'
44
- };
45
-
46
- new LambdaToKendra(this, 'sample', {
47
- lambdaFunctionProps: lambdaProps,
48
- kendraIndexProps: {},
49
- kendraDataSourceProps: [{
50
- type: 'S3',
51
- dataSourceConfiguration: {
52
- s3Configuration: {
53
- bucketName: 'your-bucket-name',
54
- }
55
- }
56
- ],
57
- });
58
- ```
59
-
60
- Python
61
-
62
- ```python
63
- TBD
64
- ```
65
-
66
- Java
67
-
68
- ```java
69
- TBD
70
- ```
71
-
72
- ## Pattern Construct Props
73
-
74
- | **Name** | **Type** | **Description** |
75
- | --- | --- | --- |
76
- | existingLambdaObj? | [`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error. |
77
- | lambdaFunctionProps? | [`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html) | User provided props to override the default props for the Lambda function. |
78
- | kendraIndexProps? | [`kendra.CfnIndexProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | Optional user provided props to override the default props for the Kendra index. Providing both these and existingKendraIndexObj is an error. |
79
- | kendraDataSourcesProps | [`CfnDataSourceProps[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html) | A list of data sources that will provide data to the Kendra index. *At least 1 must be specified*. We will do majority of processing for some data sources (S3 crawler initially), but for others the props must be complete (e.g. proper roleArn, etc.) |
80
- | indexPermissions? | `string[]` | Optional - index permissions to grant to the Lambda function. One or more of the following may be specified: `Read`, `SubmitFeedback` and `Write`. Default is `["Read", "SubmitFeedback"]`. Read is all the operations IAM defines as Read and List. SubmitFeedback is only the SubmitFeedback action. Write is all the operations IAM defines as Write and Tag. This functionality may be overridden by providing a specific role arn in lambdaFunctionProps |
81
- | existingKendraIndexObj? | [`kendra.cfnIndex`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | An existing Kendra index to which the Lambda function will be granted access. Supplying along with kendraIndexProps or kendraDataSourceProps will throw an error. |
82
- | existingVpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources. If an existing VPC is provided, the `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow clients to supply VPCs that exist outside the stack using the [`ec2.Vpc.fromLookup()`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html#static-fromwbrlookupscope-id-options) method. |
83
- | vpcProps? | [`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional user provided properties to override the default properties for the new VPC. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overridden. If `deployVpc` is not `true` then this property will be ignored. |
84
- | deployVpc? | `boolean` | Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to `true` will deploy the minimal, most private VPC to run the pattern, consisting of (1) one isolated subnet in each Availability Zone used by the CDK program; and (2) `enableDnsHostnames` and `enableDnsSupport` both being set to `true`. If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`. |
85
-
86
- ## Pattern Properties
87
-
88
- | **Name** | **Type** | **Description** |
89
- | --- | --- | --- |
90
- | lambdaFunction | [`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Returns an instance of `lambda.Function` managed by the construct |
91
- | kendraIndex | [`kendra.cfnIndex`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | Returns an instance of `kendra.cfnIndex` managed by the construct |
92
- | kendraDataSources | DataSourceProperties[] (this interface is defined by Solutions Constructs and described below) | A list of data sources created for this construct/index, each in an object that includes the role for that data source. |
93
- | lambdaRole | [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html) | The role assumed by the Lambda function |
94
- | vpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | Returns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor. |
95
-
96
- interface DataSourceProperties {
97
- role?: [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html),
98
- source: | [`CfnDataSource`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html)
99
- }
100
-
101
- ## Lambda Function
102
-
103
- This pattern requires a lambda function that can access a Kendra index.
104
-
105
- ## Default settings
106
-
107
- Out of the box implementation of the Construct without any overrides will set the following defaults:
108
-
109
- ### AWS Lambda Function
110
-
111
- * Configure limited privilege access IAM role for Lambda function
112
- * Enable reusing connections with Keep-Alive for Node.js Lambda function
113
- * Enable X-Ray Tracing
114
- * Set Environment Variables
115
-
116
- * (default) KENDRA_INDEX_ID
117
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED
118
-
119
- ### Amazon Kendra Index
120
-
121
- * Creates Amazon Kendra endpoint in VPC if appropriate
122
- * Defaults to DEVELOPER_EDITION
123
-
124
- **Amazon Kendra DataSources**
125
-
126
- * Sets up correct IAM roles to access data for:
127
-
128
- * S3 data sources
129
- * Which others should we support in MLP? https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
130
- * Adds each data source to Kendra index
131
-
132
- ## Architecture
133
-
134
- ![Architecture Diagram](architecture.png)
135
-
136
- ---
137
-
138
-
139
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-lambda-kendra/README.adoc)
140
3
  '''
141
4
  from pkgutil import extend_path
142
5
  __path__ = extend_path(__path__, __name__)
{aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs/aws_lambda_kendra/_jsii/__init__.py RENAMED
@@ -34,9 +34,9 @@ import constructs._jsii
34
34
 
35
35
  __jsii_assembly__ = jsii.JSIIAssembly.load(
36
36
  "@aws-solutions-constructs/aws-lambda-kendra",
37
- "2.85.2",
37
+ "2.85.3",
38
38
  __name__[0:-6],
39
- "aws-lambda-kendra@2.85.2.jsii.tgz",
39
+ "aws-lambda-kendra@2.85.3.jsii.tgz",
40
40
  )
41
41
 
42
42
  __all__ = [
aws_solutions_constructs_aws_lambda_kendra-2.85.3/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/PKG-INFO ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-lambda-kendra
3
+ Version: 2.85.3
4
+ Summary: CDK constructs for defining an interaction between an AWS Lambda function and an existing Amazon Kinesis Firehose Delivery Stream.
5
+ Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
+ Author: Amazon Web Services
7
+ License: Apache-2.0
8
+ Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: JavaScript
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Typing :: Typed
17
+ Classifier: License :: OSI Approved
18
+ Requires-Python: ~=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
+ Requires-Dist: aws-solutions-constructs.core==2.85.3
23
+ Requires-Dist: constructs<11.0.0,>=10.0.0
24
+ Requires-Dist: jsii<2.0.0,>=1.111.0
25
+ Requires-Dist: publication>=0.0.3
26
+ Requires-Dist: typeguard<4.3.0,>=2.13.3
27
+
28
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-lambda-kendra/README.adoc)
{aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/SOURCES.txt RENAMED
@@ -11,4 +11,4 @@ src/aws_solutions_constructs.aws_lambda_kendra.egg-info/top_level.txt
11
11
  src/aws_solutions_constructs/aws_lambda_kendra/__init__.py
12
12
  src/aws_solutions_constructs/aws_lambda_kendra/py.typed
13
13
  src/aws_solutions_constructs/aws_lambda_kendra/_jsii/__init__.py
14
- src/aws_solutions_constructs/aws_lambda_kendra/_jsii/aws-lambda-kendra@2.85.2.jsii.tgz
14
+ src/aws_solutions_constructs/aws_lambda_kendra/_jsii/aws-lambda-kendra@2.85.3.jsii.tgz
{aws_solutions_constructs_aws_lambda_kendra-2.85.2 → aws_solutions_constructs_aws_lambda_kendra-2.85.3}/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/requires.txt RENAMED
@@ -1,5 +1,5 @@
1
1
  aws-cdk-lib<3.0.0,>=2.193.0
2
- aws-solutions-constructs.core==2.85.2
2
+ aws-solutions-constructs.core==2.85.3
3
3
  constructs<11.0.0,>=10.0.0
4
4
  jsii<2.0.0,>=1.111.0
5
5
  publication>=0.0.3
aws_solutions_constructs_aws_lambda_kendra-2.85.2/PKG-INFO DELETED
@@ -1,165 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-lambda-kendra
3
- Version: 2.85.2
4
- Summary: CDK constructs for defining an interaction between an AWS Lambda function and an existing Amazon Kinesis Firehose Delivery Stream.
5
- Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
- Author: Amazon Web Services
7
- License: Apache-2.0
8
- Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
- Classifier: Intended Audience :: Developers
10
- Classifier: Operating System :: OS Independent
11
- Classifier: Programming Language :: JavaScript
12
- Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Typing :: Typed
17
- Classifier: License :: OSI Approved
18
- Requires-Python: ~=3.9
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
- Requires-Dist: aws-solutions-constructs.core==2.85.2
23
- Requires-Dist: constructs<11.0.0,>=10.0.0
24
- Requires-Dist: jsii<2.0.0,>=1.111.0
25
- Requires-Dist: publication>=0.0.3
26
- Requires-Dist: typeguard<4.3.0,>=2.13.3
27
-
28
- # aws-lambda-kendra module
29
-
30
- ---
31
-
32
-
33
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
34
-
35
- > All classes are under active development and subject to non-backward compatible changes or removal in any
36
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
37
- > 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.
38
-
39
- ---
40
-
41
-
42
- | **Reference Documentation**: | <span style="font-weight: normal;">https://docs.aws.amazon.com/solutions/latest/constructs/</span> |
43
- | --- | --- |
44
-
45
- | **Language** | **Package** |
46
- | --- | --- |
47
- | ![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python | `aws_solutions_constructs.aws_lambda_kendra` |
48
- | ![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript | `@aws-solutions-constructs/aws-lambda-kendra` |
49
- | ![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java | `software.amazon.awsconstructs.services.lambdakendra` |
50
-
51
- ## Overview
52
-
53
- This AWS Solutions Construct implements an AWS Lambda function and Amazon Kendra index with the least privileged permissions.
54
-
55
- Here is a minimal deployable pattern definition:
56
-
57
- Typescript
58
-
59
- ```python
60
- import { Construct } from 'constructs';
61
- import { Stack, StackProps, Aws } from 'aws-cdk-lib';
62
- import { LambdaToKendra } from '@aws-solutions-constructs/aws-lambda-kendra';
63
- import * as lambda from "aws-cdk-lib/aws-lambda";
64
- import * as s3 from "aws-cdk-lib/aws-s3";
65
-
66
- const lambdaProps: lambda.FunctionProps = {
67
- code: lambda.Code.fromAsset(`lambda`),
68
- runtime: lambda.Runtime.NODEJS_20_X,
69
- handler: 'index.handler'
70
- };
71
-
72
- new LambdaToKendra(this, 'sample', {
73
- lambdaFunctionProps: lambdaProps,
74
- kendraIndexProps: {},
75
- kendraDataSourceProps: [{
76
- type: 'S3',
77
- dataSourceConfiguration: {
78
- s3Configuration: {
79
- bucketName: 'your-bucket-name',
80
- }
81
- }
82
- ],
83
- });
84
- ```
85
-
86
- Python
87
-
88
- ```python
89
- TBD
90
- ```
91
-
92
- Java
93
-
94
- ```java
95
- TBD
96
- ```
97
-
98
- ## Pattern Construct Props
99
-
100
- | **Name** | **Type** | **Description** |
101
- | --- | --- | --- |
102
- | existingLambdaObj? | [`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error. |
103
- | lambdaFunctionProps? | [`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html) | User provided props to override the default props for the Lambda function. |
104
- | kendraIndexProps? | [`kendra.CfnIndexProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | Optional user provided props to override the default props for the Kendra index. Providing both these and existingKendraIndexObj is an error. |
105
- | kendraDataSourcesProps | [`CfnDataSourceProps[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html) | A list of data sources that will provide data to the Kendra index. *At least 1 must be specified*. We will do majority of processing for some data sources (S3 crawler initially), but for others the props must be complete (e.g. proper roleArn, etc.) |
106
- | indexPermissions? | `string[]` | Optional - index permissions to grant to the Lambda function. One or more of the following may be specified: `Read`, `SubmitFeedback` and `Write`. Default is `["Read", "SubmitFeedback"]`. Read is all the operations IAM defines as Read and List. SubmitFeedback is only the SubmitFeedback action. Write is all the operations IAM defines as Write and Tag. This functionality may be overridden by providing a specific role arn in lambdaFunctionProps |
107
- | existingKendraIndexObj? | [`kendra.cfnIndex`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | An existing Kendra index to which the Lambda function will be granted access. Supplying along with kendraIndexProps or kendraDataSourceProps will throw an error. |
108
- | existingVpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources. If an existing VPC is provided, the `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow clients to supply VPCs that exist outside the stack using the [`ec2.Vpc.fromLookup()`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html#static-fromwbrlookupscope-id-options) method. |
109
- | vpcProps? | [`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional user provided properties to override the default properties for the new VPC. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overridden. If `deployVpc` is not `true` then this property will be ignored. |
110
- | deployVpc? | `boolean` | Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to `true` will deploy the minimal, most private VPC to run the pattern, consisting of (1) one isolated subnet in each Availability Zone used by the CDK program; and (2) `enableDnsHostnames` and `enableDnsSupport` both being set to `true`. If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`. |
111
-
112
- ## Pattern Properties
113
-
114
- | **Name** | **Type** | **Description** |
115
- | --- | --- | --- |
116
- | lambdaFunction | [`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Returns an instance of `lambda.Function` managed by the construct |
117
- | kendraIndex | [`kendra.cfnIndex`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | Returns an instance of `kendra.cfnIndex` managed by the construct |
118
- | kendraDataSources | DataSourceProperties[] (this interface is defined by Solutions Constructs and described below) | A list of data sources created for this construct/index, each in an object that includes the role for that data source. |
119
- | lambdaRole | [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html) | The role assumed by the Lambda function |
120
- | vpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | Returns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor. |
121
-
122
- interface DataSourceProperties {
123
- role?: [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html),
124
- source: | [`CfnDataSource`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html)
125
- }
126
-
127
- ## Lambda Function
128
-
129
- This pattern requires a lambda function that can access a Kendra index.
130
-
131
- ## Default settings
132
-
133
- Out of the box implementation of the Construct without any overrides will set the following defaults:
134
-
135
- ### AWS Lambda Function
136
-
137
- * Configure limited privilege access IAM role for Lambda function
138
- * Enable reusing connections with Keep-Alive for Node.js Lambda function
139
- * Enable X-Ray Tracing
140
- * Set Environment Variables
141
-
142
- * (default) KENDRA_INDEX_ID
143
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED
144
-
145
- ### Amazon Kendra Index
146
-
147
- * Creates Amazon Kendra endpoint in VPC if appropriate
148
- * Defaults to DEVELOPER_EDITION
149
-
150
- **Amazon Kendra DataSources**
151
-
152
- * Sets up correct IAM roles to access data for:
153
-
154
- * S3 data sources
155
- * Which others should we support in MLP? https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
156
- * Adds each data source to Kendra index
157
-
158
- ## Architecture
159
-
160
- ![Architecture Diagram](architecture.png)
161
-
162
- ---
163
-
164
-
165
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
aws_solutions_constructs_aws_lambda_kendra-2.85.2/README.md DELETED
@@ -1,138 +0,0 @@
1
- # aws-lambda-kendra module
2
-
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
-
14
-
15
- | **Reference Documentation**: | <span style="font-weight: normal;">https://docs.aws.amazon.com/solutions/latest/constructs/</span> |
16
- | --- | --- |
17
-
18
- | **Language** | **Package** |
19
- | --- | --- |
20
- | ![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python | `aws_solutions_constructs.aws_lambda_kendra` |
21
- | ![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript | `@aws-solutions-constructs/aws-lambda-kendra` |
22
- | ![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java | `software.amazon.awsconstructs.services.lambdakendra` |
23
-
24
- ## Overview
25
-
26
- This AWS Solutions Construct implements an AWS Lambda function and Amazon Kendra index with the least privileged permissions.
27
-
28
- Here is a minimal deployable pattern definition:
29
-
30
- Typescript
31
-
32
- ```python
33
- import { Construct } from 'constructs';
34
- import { Stack, StackProps, Aws } from 'aws-cdk-lib';
35
- import { LambdaToKendra } from '@aws-solutions-constructs/aws-lambda-kendra';
36
- import * as lambda from "aws-cdk-lib/aws-lambda";
37
- import * as s3 from "aws-cdk-lib/aws-s3";
38
-
39
- const lambdaProps: lambda.FunctionProps = {
40
- code: lambda.Code.fromAsset(`lambda`),
41
- runtime: lambda.Runtime.NODEJS_20_X,
42
- handler: 'index.handler'
43
- };
44
-
45
- new LambdaToKendra(this, 'sample', {
46
- lambdaFunctionProps: lambdaProps,
47
- kendraIndexProps: {},
48
- kendraDataSourceProps: [{
49
- type: 'S3',
50
- dataSourceConfiguration: {
51
- s3Configuration: {
52
- bucketName: 'your-bucket-name',
53
- }
54
- }
55
- ],
56
- });
57
- ```
58
-
59
- Python
60
-
61
- ```python
62
- TBD
63
- ```
64
-
65
- Java
66
-
67
- ```java
68
- TBD
69
- ```
70
-
71
- ## Pattern Construct Props
72
-
73
- | **Name** | **Type** | **Description** |
74
- | --- | --- | --- |
75
- | existingLambdaObj? | [`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error. |
76
- | lambdaFunctionProps? | [`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html) | User provided props to override the default props for the Lambda function. |
77
- | kendraIndexProps? | [`kendra.CfnIndexProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | Optional user provided props to override the default props for the Kendra index. Providing both these and existingKendraIndexObj is an error. |
78
- | kendraDataSourcesProps | [`CfnDataSourceProps[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html) | A list of data sources that will provide data to the Kendra index. *At least 1 must be specified*. We will do majority of processing for some data sources (S3 crawler initially), but for others the props must be complete (e.g. proper roleArn, etc.) |
79
- | indexPermissions? | `string[]` | Optional - index permissions to grant to the Lambda function. One or more of the following may be specified: `Read`, `SubmitFeedback` and `Write`. Default is `["Read", "SubmitFeedback"]`. Read is all the operations IAM defines as Read and List. SubmitFeedback is only the SubmitFeedback action. Write is all the operations IAM defines as Write and Tag. This functionality may be overridden by providing a specific role arn in lambdaFunctionProps |
80
- | existingKendraIndexObj? | [`kendra.cfnIndex`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | An existing Kendra index to which the Lambda function will be granted access. Supplying along with kendraIndexProps or kendraDataSourceProps will throw an error. |
81
- | existingVpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources. If an existing VPC is provided, the `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow clients to supply VPCs that exist outside the stack using the [`ec2.Vpc.fromLookup()`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html#static-fromwbrlookupscope-id-options) method. |
82
- | vpcProps? | [`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional user provided properties to override the default properties for the new VPC. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overridden. If `deployVpc` is not `true` then this property will be ignored. |
83
- | deployVpc? | `boolean` | Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to `true` will deploy the minimal, most private VPC to run the pattern, consisting of (1) one isolated subnet in each Availability Zone used by the CDK program; and (2) `enableDnsHostnames` and `enableDnsSupport` both being set to `true`. If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`. |
84
-
85
- ## Pattern Properties
86
-
87
- | **Name** | **Type** | **Description** |
88
- | --- | --- | --- |
89
- | lambdaFunction | [`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Returns an instance of `lambda.Function` managed by the construct |
90
- | kendraIndex | [`kendra.cfnIndex`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | Returns an instance of `kendra.cfnIndex` managed by the construct |
91
- | kendraDataSources | DataSourceProperties[] (this interface is defined by Solutions Constructs and described below) | A list of data sources created for this construct/index, each in an object that includes the role for that data source. |
92
- | lambdaRole | [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html) | The role assumed by the Lambda function |
93
- | vpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | Returns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor. |
94
-
95
- interface DataSourceProperties {
96
- role?: [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html),
97
- source: | [`CfnDataSource`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html)
98
- }
99
-
100
- ## Lambda Function
101
-
102
- This pattern requires a lambda function that can access a Kendra index.
103
-
104
- ## Default settings
105
-
106
- Out of the box implementation of the Construct without any overrides will set the following defaults:
107
-
108
- ### AWS Lambda Function
109
-
110
- * Configure limited privilege access IAM role for Lambda function
111
- * Enable reusing connections with Keep-Alive for Node.js Lambda function
112
- * Enable X-Ray Tracing
113
- * Set Environment Variables
114
-
115
- * (default) KENDRA_INDEX_ID
116
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED
117
-
118
- ### Amazon Kendra Index
119
-
120
- * Creates Amazon Kendra endpoint in VPC if appropriate
121
- * Defaults to DEVELOPER_EDITION
122
-
123
- **Amazon Kendra DataSources**
124
-
125
- * Sets up correct IAM roles to access data for:
126
-
127
- * S3 data sources
128
- * Which others should we support in MLP? https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
129
- * Adds each data source to Kendra index
130
-
131
- ## Architecture
132
-
133
- ![Architecture Diagram](architecture.png)
134
-
135
- ---
136
-
137
-
138
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
aws_solutions_constructs_aws_lambda_kendra-2.85.2/src/aws_solutions_constructs.aws_lambda_kendra.egg-info/PKG-INFO DELETED
@@ -1,165 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-lambda-kendra
3
- Version: 2.85.2
4
- Summary: CDK constructs for defining an interaction between an AWS Lambda function and an existing Amazon Kinesis Firehose Delivery Stream.
5
- Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
- Author: Amazon Web Services
7
- License: Apache-2.0
8
- Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
- Classifier: Intended Audience :: Developers
10
- Classifier: Operating System :: OS Independent
11
- Classifier: Programming Language :: JavaScript
12
- Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Typing :: Typed
17
- Classifier: License :: OSI Approved
18
- Requires-Python: ~=3.9
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
- Requires-Dist: aws-solutions-constructs.core==2.85.2
23
- Requires-Dist: constructs<11.0.0,>=10.0.0
24
- Requires-Dist: jsii<2.0.0,>=1.111.0
25
- Requires-Dist: publication>=0.0.3
26
- Requires-Dist: typeguard<4.3.0,>=2.13.3
27
-
28
- # aws-lambda-kendra module
29
-
30
- ---
31
-
32
-
33
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
34
-
35
- > All classes are under active development and subject to non-backward compatible changes or removal in any
36
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
37
- > 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.
38
-
39
- ---
40
-
41
-
42
- | **Reference Documentation**: | <span style="font-weight: normal;">https://docs.aws.amazon.com/solutions/latest/constructs/</span> |
43
- | --- | --- |
44
-
45
- | **Language** | **Package** |
46
- | --- | --- |
47
- | ![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python | `aws_solutions_constructs.aws_lambda_kendra` |
48
- | ![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript | `@aws-solutions-constructs/aws-lambda-kendra` |
49
- | ![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java | `software.amazon.awsconstructs.services.lambdakendra` |
50
-
51
- ## Overview
52
-
53
- This AWS Solutions Construct implements an AWS Lambda function and Amazon Kendra index with the least privileged permissions.
54
-
55
- Here is a minimal deployable pattern definition:
56
-
57
- Typescript
58
-
59
- ```python
60
- import { Construct } from 'constructs';
61
- import { Stack, StackProps, Aws } from 'aws-cdk-lib';
62
- import { LambdaToKendra } from '@aws-solutions-constructs/aws-lambda-kendra';
63
- import * as lambda from "aws-cdk-lib/aws-lambda";
64
- import * as s3 from "aws-cdk-lib/aws-s3";
65
-
66
- const lambdaProps: lambda.FunctionProps = {
67
- code: lambda.Code.fromAsset(`lambda`),
68
- runtime: lambda.Runtime.NODEJS_20_X,
69
- handler: 'index.handler'
70
- };
71
-
72
- new LambdaToKendra(this, 'sample', {
73
- lambdaFunctionProps: lambdaProps,
74
- kendraIndexProps: {},
75
- kendraDataSourceProps: [{
76
- type: 'S3',
77
- dataSourceConfiguration: {
78
- s3Configuration: {
79
- bucketName: 'your-bucket-name',
80
- }
81
- }
82
- ],
83
- });
84
- ```
85
-
86
- Python
87
-
88
- ```python
89
- TBD
90
- ```
91
-
92
- Java
93
-
94
- ```java
95
- TBD
96
- ```
97
-
98
- ## Pattern Construct Props
99
-
100
- | **Name** | **Type** | **Description** |
101
- | --- | --- | --- |
102
- | existingLambdaObj? | [`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error. |
103
- | lambdaFunctionProps? | [`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html) | User provided props to override the default props for the Lambda function. |
104
- | kendraIndexProps? | [`kendra.CfnIndexProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | Optional user provided props to override the default props for the Kendra index. Providing both these and existingKendraIndexObj is an error. |
105
- | kendraDataSourcesProps | [`CfnDataSourceProps[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html) | A list of data sources that will provide data to the Kendra index. *At least 1 must be specified*. We will do majority of processing for some data sources (S3 crawler initially), but for others the props must be complete (e.g. proper roleArn, etc.) |
106
- | indexPermissions? | `string[]` | Optional - index permissions to grant to the Lambda function. One or more of the following may be specified: `Read`, `SubmitFeedback` and `Write`. Default is `["Read", "SubmitFeedback"]`. Read is all the operations IAM defines as Read and List. SubmitFeedback is only the SubmitFeedback action. Write is all the operations IAM defines as Write and Tag. This functionality may be overridden by providing a specific role arn in lambdaFunctionProps |
107
- | existingKendraIndexObj? | [`kendra.cfnIndex`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | An existing Kendra index to which the Lambda function will be granted access. Supplying along with kendraIndexProps or kendraDataSourceProps will throw an error. |
108
- | existingVpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources. If an existing VPC is provided, the `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow clients to supply VPCs that exist outside the stack using the [`ec2.Vpc.fromLookup()`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html#static-fromwbrlookupscope-id-options) method. |
109
- | vpcProps? | [`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional user provided properties to override the default properties for the new VPC. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overridden. If `deployVpc` is not `true` then this property will be ignored. |
110
- | deployVpc? | `boolean` | Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to `true` will deploy the minimal, most private VPC to run the pattern, consisting of (1) one isolated subnet in each Availability Zone used by the CDK program; and (2) `enableDnsHostnames` and `enableDnsSupport` both being set to `true`. If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`. |
111
-
112
- ## Pattern Properties
113
-
114
- | **Name** | **Type** | **Description** |
115
- | --- | --- | --- |
116
- | lambdaFunction | [`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Returns an instance of `lambda.Function` managed by the construct |
117
- | kendraIndex | [`kendra.cfnIndex`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnIndex.html) | Returns an instance of `kendra.cfnIndex` managed by the construct |
118
- | kendraDataSources | DataSourceProperties[] (this interface is defined by Solutions Constructs and described below) | A list of data sources created for this construct/index, each in an object that includes the role for that data source. |
119
- | lambdaRole | [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html) | The role assumed by the Lambda function |
120
- | vpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | Returns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor. |
121
-
122
- interface DataSourceProperties {
123
- role?: [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html),
124
- source: | [`CfnDataSource`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html)
125
- }
126
-
127
- ## Lambda Function
128
-
129
- This pattern requires a lambda function that can access a Kendra index.
130
-
131
- ## Default settings
132
-
133
- Out of the box implementation of the Construct without any overrides will set the following defaults:
134
-
135
- ### AWS Lambda Function
136
-
137
- * Configure limited privilege access IAM role for Lambda function
138
- * Enable reusing connections with Keep-Alive for Node.js Lambda function
139
- * Enable X-Ray Tracing
140
- * Set Environment Variables
141
-
142
- * (default) KENDRA_INDEX_ID
143
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED
144
-
145
- ### Amazon Kendra Index
146
-
147
- * Creates Amazon Kendra endpoint in VPC if appropriate
148
- * Defaults to DEVELOPER_EDITION
149
-
150
- **Amazon Kendra DataSources**
151
-
152
- * Sets up correct IAM roles to access data for:
153
-
154
- * S3 data sources
155
- * Which others should we support in MLP? https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
156
- * Adds each data source to Kendra index
157
-
158
- ## Architecture
159
-
160
- ![Architecture Diagram](architecture.png)
161
-
162
- ---
163
-
164
-
165
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.