interface CustomDocumentEnrichmentConfigurationProperty

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

Provides the configuration information for altering document metadata and content during the document ingestion process.

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 customDocumentEnrichmentConfigurationProperty: kendra.CfnDataSource.CustomDocumentEnrichmentConfigurationProperty = {
  inlineConfigurations: [{
    condition: {
      conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
      operator: 'operator',

      // the properties below are optional
      conditionOnValue: {
        dateValue: 'dateValue',
        longValue: 123,
        stringListValue: ['stringListValue'],
        stringValue: 'stringValue',
      },
    },
    documentContentDeletion: false,
    target: {
      targetDocumentAttributeKey: 'targetDocumentAttributeKey',

      // the properties below are optional
      targetDocumentAttributeValue: {
        dateValue: 'dateValue',
        longValue: 123,
        stringListValue: ['stringListValue'],
        stringValue: 'stringValue',
      },
      targetDocumentAttributeValueDeletion: false,
    },
  }],
  postExtractionHookConfiguration: {
    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',
      },
    },
  },
  preExtractionHookConfiguration: {
    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',
      },
    },
  },
  roleArn: 'roleArn',
};

Properties

Name	Type	Description
inlineConfigurations?	IResolvable | IResolvable | InlineCustomDocumentEnrichmentConfigurationProperty[]	Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
postExtractionHookConfiguration?	IResolvable | HookConfigurationProperty	Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted.
preExtractionHookConfiguration?	IResolvable | HookConfigurationProperty	Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text.
roleArn?	string	The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

---

inlineConfigurations?

Type: IResolvable | IResolvable | InlineCustomDocumentEnrichmentConfigurationProperty[] (optional)

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

---

postExtractionHookConfiguration?

Type: IResolvable | HookConfigurationProperty (optional)

Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted.

You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .

---

preExtractionHookConfiguration?

Type: IResolvable | HookConfigurationProperty (optional)

Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text.

You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .

---

roleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

For more information, see IAM roles for Amazon Kendra .