interface HookConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Kendra.CfnDataSource.HookConfigurationProperty
Java	software.amazon.awscdk.services.kendra.CfnDataSource.HookConfigurationProperty
Python	aws_cdk.aws_kendra.CfnDataSource.HookConfigurationProperty
TypeScript	@aws-cdk/aws-kendra » CfnDataSource » HookConfigurationProperty

Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Kendra.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using PostExtractionHookConfiguration . You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Customizing document metadata during the ingestion process .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kendra from '@aws-cdk/aws-kendra';
const hookConfigurationProperty: kendra.CfnDataSource.HookConfigurationProperty = {
  lambdaArn: 'lambdaArn',
  s3Bucket: 's3Bucket',

  // the properties below are optional
  invocationCondition: {
    conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
    operator: 'operator',

    // the properties below are optional
    conditionOnValue: {
      dateValue: 'dateValue',
      longValue: 123,
      stringListValue: ['stringListValue'],
      stringValue: 'stringValue',
    },
  },
};

Properties

Name	Type	Description
lambdaArn	string	The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
s3Bucket	string	Stores the original, raw documents or the structured, parsed documents before and after altering them.
invocationCondition?	IResolvable | DocumentAttributeConditionProperty	The condition used for when a Lambda function should be invoked.

---

lambdaArn

Type: string

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.

For more information, see IAM roles for Amazon Kendra .

---

s3Bucket

Type: string

Stores the original, raw documents or the structured, parsed documents before and after altering them.

For more information, see Data contracts for Lambda functions .

---

invocationCondition?

Type: IResolvable | DocumentAttributeConditionProperty (optional)

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.