# aws-lambda-kendra module
---
> All classes are under active development and subject to non-backward compatible changes or removal in any
> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
> 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.
---
| **Reference Documentation**: | <span style="font-weight: normal;">https://docs.aws.amazon.com/solutions/latest/constructs/</span> |
| --- | --- |
| **Language** | **Package** |
| --- | --- |
|  Python | `aws_solutions_constructs.aws_lambda_kendra` |
|  Typescript | `@aws-solutions-constructs/aws-lambda-kendra` |
|  Java | `software.amazon.awsconstructs.services.lambdakendra` |
## Overview
This AWS Solutions Construct implements an AWS Lambda function and Amazon Kendra index with the least privileged permissions.
Here is a minimal deployable pattern definition:
Typescript
```python
import { Construct } from 'constructs';
import { Stack, StackProps, Aws } from 'aws-cdk-lib';
import { LambdaToKendra } from '@aws-solutions-constructs/aws-lambda-kendra';
import * as lambda from "aws-cdk-lib/aws-lambda";
import * as s3 from "aws-cdk-lib/aws-s3";
const lambdaProps: lambda.FunctionProps = {
code: lambda.Code.fromAsset(`lambda`),
runtime: lambda.Runtime.NODEJS_18_X,
handler: 'index.handler'
};
new LambdaToKendra(this, 'sample', {
lambdaFunctionProps: lambdaProps,
kendraIndexProps: {},
kendraDataSourceProps: [{
type: 'S3',
dataSourceConfiguration: {
s3Configuration: {
bucketName: 'your-bucket-name',
}
}
],
});
```
Python
```python
TBD
```
Java
```java
TBD
```
## Pattern Construct Props
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| 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. |
| 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. |
| 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. |
| 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.) |
| 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 |
| 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. |
| 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. |
| 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. |
| 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`. |
## Pattern Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| 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 |
| 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 |
| 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. |
| 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 |
| 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. |
interface DataSourceProperties {
role?: [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html),
source: | [`CfnDataSource`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html)
}
## Lambda Function
This pattern requires a lambda function that can access a Kendra index.
## Default settings
Out of the box implementation of the Construct without any overrides will set the following defaults:
### AWS Lambda Function
* Configure limited privilege access IAM role for Lambda function
* Enable reusing connections with Keep-Alive for Node.js Lambda function
* Enable X-Ray Tracing
* Set Environment Variables
* (default) KENDRA_INDEX_ID
* AWS_NODEJS_CONNECTION_REUSE_ENABLED
### Amazon Kendra Index
* Creates Amazon Kendra endpoint in VPC if appropriate
* Defaults to DEVELOPER_EDITION
**Amazon Kendra DataSources**
* Sets up correct IAM roles to access data for:
* S3 data sources
* Which others should we support in MLP? https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
* Adds each data source to Kendra index
## Architecture
---
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Raw data
{
"_id": null,
"home_page": "https://github.com/awslabs/aws-solutions-constructs.git",
"name": "aws-solutions-constructs.aws-lambda-kendra",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/84/df/1969829b069c985b24e58429ff62a3524a070ebeb00907afa60259a7e160/aws_solutions_constructs_aws_lambda_kendra-2.74.0.tar.gz",
"platform": null,
"description": "# aws-lambda-kendra module\n\n---\n\n\n\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\n\n| **Reference Documentation**: | <span style=\"font-weight: normal;\">https://docs.aws.amazon.com/solutions/latest/constructs/</span> |\n| --- | --- |\n\n| **Language** | **Package** |\n| --- | --- |\n|  Python | `aws_solutions_constructs.aws_lambda_kendra` |\n|  Typescript | `@aws-solutions-constructs/aws-lambda-kendra` |\n|  Java | `software.amazon.awsconstructs.services.lambdakendra` |\n\n## Overview\n\nThis AWS Solutions Construct implements an AWS Lambda function and Amazon Kendra index with the least privileged permissions.\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n\n```python\nimport { Construct } from 'constructs';\nimport { Stack, StackProps, Aws } from 'aws-cdk-lib';\nimport { LambdaToKendra } from '@aws-solutions-constructs/aws-lambda-kendra';\nimport * as lambda from \"aws-cdk-lib/aws-lambda\";\nimport * as s3 from \"aws-cdk-lib/aws-s3\";\n\nconst lambdaProps: lambda.FunctionProps = {\n code: lambda.Code.fromAsset(`lambda`),\n runtime: lambda.Runtime.NODEJS_18_X,\n handler: 'index.handler'\n};\n\nnew LambdaToKendra(this, 'sample', {\n lambdaFunctionProps: lambdaProps,\n kendraIndexProps: {},\n kendraDataSourceProps: [{\n type: 'S3',\n dataSourceConfiguration: {\n s3Configuration: {\n bucketName: 'your-bucket-name',\n }\n }\n ],\n});\n```\n\nPython\n\n```python\nTBD\n```\n\nJava\n\n```java\nTBD\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| 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. |\n| 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. |\n| 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. |\n| 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.) |\n| indexPermissions? | `string[]` | Optional - index permissions to grant to the Lambda function. One or more of the following may be specified:\u00a0`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 |\n| 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. |\n| 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. |\n| 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. |\n| 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`. |\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n| --- | --- | --- |\n| 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 |\n| 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 |\n| 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. |\n| 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 |\n| 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. |\n\ninterface DataSourceProperties {\nrole?: [`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html),\nsource: | [`CfnDataSource`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnDataSource.html)\n}\n\n## Lambda Function\n\nThis pattern requires a lambda function that can access a Kendra index.\n\n## Default settings\n\nOut of the box implementation of the Construct without any overrides will set the following defaults:\n\n### AWS Lambda Function\n\n* Configure limited privilege access IAM role for Lambda function\n* Enable reusing connections with Keep-Alive for Node.js Lambda function\n* Enable X-Ray Tracing\n* Set Environment Variables\n\n * (default) KENDRA_INDEX_ID\n * AWS_NODEJS_CONNECTION_REUSE_ENABLED\n\n### Amazon Kendra Index\n\n* Creates Amazon Kendra endpoint in VPC if appropriate\n* Defaults to DEVELOPER_EDITION\n\n**Amazon Kendra DataSources**\n\n* Sets up correct IAM roles to access data for:\n\n * S3 data sources\n * Which others should we support in MLP? https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html\n* Adds each data source to Kendra index\n\n## Architecture\n\n\n\n---\n\n\n\u00a9 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "CDK constructs for defining an interaction between an AWS Lambda function and an existing Amazon Kinesis Firehose Delivery Stream.",
"version": "2.74.0",
"project_urls": {
"Homepage": "https://github.com/awslabs/aws-solutions-constructs.git",
"Source": "https://github.com/awslabs/aws-solutions-constructs.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b76385e215f9b8596607186afdb13fb2d39b1842b93d0164abcebdd243449e1c",
"md5": "8f761e344ea1ebea734b4685da1b231b",
"sha256": "d8c989a31348047038a4960c6c15425877e9dbfc80b990e502ebd4731eec124e"
},
"downloads": -1,
"filename": "aws_solutions_constructs.aws_lambda_kendra-2.74.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f761e344ea1ebea734b4685da1b231b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 136143,
"upload_time": "2024-10-22T18:08:16",
"upload_time_iso_8601": "2024-10-22T18:08:16.837546Z",
"url": "https://files.pythonhosted.org/packages/b7/63/85e215f9b8596607186afdb13fb2d39b1842b93d0164abcebdd243449e1c/aws_solutions_constructs.aws_lambda_kendra-2.74.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "84df1969829b069c985b24e58429ff62a3524a070ebeb00907afa60259a7e160",
"md5": "9dd91ca85e10f99f57fd6e6d402b76df",
"sha256": "66dbb1ad7d774e69b7b9d4a375e791a61dbfc8b52b241b09667d2eec28fc16ba"
},
"downloads": -1,
"filename": "aws_solutions_constructs_aws_lambda_kendra-2.74.0.tar.gz",
"has_sig": false,
"md5_digest": "9dd91ca85e10f99f57fd6e6d402b76df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 137704,
"upload_time": "2024-10-22T18:09:49",
"upload_time_iso_8601": "2024-10-22T18:09:49.627968Z",
"url": "https://files.pythonhosted.org/packages/84/df/1969829b069c985b24e58429ff62a3524a070ebeb00907afa60259a7e160/aws_solutions_constructs_aws_lambda_kendra-2.74.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 18:09:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "awslabs",
"github_project": "aws-solutions-constructs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-solutions-constructs.aws-lambda-kendra"
}
JSON
