software.amazon.awscdk.services.kendra

Interface CfnDataSource.HookConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.HookConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.HookConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.kendra.*;
 HookConfigurationProperty hookConfigurationProperty = HookConfigurationProperty.builder()
         .lambdaArn("lambdaArn")
         .s3Bucket("s3Bucket")
         // the properties below are optional
         .invocationCondition(DocumentAttributeConditionProperty.builder()
                 .conditionDocumentAttributeKey("conditionDocumentAttributeKey")
                 .operator("operator")
                 // the properties below are optional
                 .conditionOnValue(DocumentAttributeValueProperty.builder()
                         .dateValue("dateValue")
                         .longValue(123)
                         .stringListValue(List.of("stringListValue"))
                         .stringValue("stringValue")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.HookConfigurationProperty.Builder A builder for CfnDataSource.HookConfigurationProperty
static class	CfnDataSource.HookConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.HookConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.HookConfigurationProperty.Builder	builder()
default Object	getInvocationCondition() The condition used for when a Lambda function should be invoked.
String	getLambdaArn() The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
String	getS3Bucket() Stores the original, raw documents or the structured, parsed documents before and after altering them.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLambdaArn

@Stability(value=Stable)
 @NotNull
String getLambdaArn()

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 .

getS3Bucket

@Stability(value=Stable)
 @NotNull
String getS3Bucket()

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

For more information, see Data contracts for Lambda functions .

getInvocationCondition

@Stability(value=Stable)
 @Nullable
default Object getInvocationCondition()

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.

builder

@Stability(value=Stable)
static CfnDataSource.HookConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.HookConfigurationProperty.Builder of CfnDataSource.HookConfigurationProperty