Class 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.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.AWS.Kendra.dll
Syntax (csharp)
public class HookConfigurationProperty : Object, CfnDataSource.IHookConfigurationProperty
Syntax (vb)
Public Class HookConfigurationProperty
Inherits Object
Implements CfnDataSource.IHookConfigurationProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var hookConfigurationProperty = new HookConfigurationProperty {
LambdaArn = "lambdaArn",
S3Bucket = "s3Bucket",
// the properties below are optional
InvocationCondition = new DocumentAttributeConditionProperty {
ConditionDocumentAttributeKey = "conditionDocumentAttributeKey",
Operator = "operator",
// the properties below are optional
ConditionOnValue = new DocumentAttributeValueProperty {
DateValue = "dateValue",
LongValue = 123,
StringListValue = new [] { "stringListValue" },
StringValue = "stringValue"
}
}
};
Synopsis
Constructors
HookConfigurationProperty() |
Properties
InvocationCondition | The condition used for when a Lambda function should be invoked. |
LambdaArn | The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. |
S3Bucket | Stores the original, raw documents or the structured, parsed documents before and after altering them. |
Constructors
HookConfigurationProperty()
public HookConfigurationProperty()
Properties
InvocationCondition
The condition used for when a Lambda function should be invoked.
public object InvocationCondition { get; set; }
Property Value
System.Object
Remarks
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.
LambdaArn
The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
public string LambdaArn { get; set; }
Property Value
System.String
Remarks
S3Bucket
Stores the original, raw documents or the structured, parsed documents before and after altering them.
public string S3Bucket { get; set; }
Property Value
System.String