interface DocumentEnrichmentConfigurationProperty

Language	Type name
.NET	Amazon.CDK.aws_qbusiness.CfnDataSource.DocumentEnrichmentConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnDataSource_DocumentEnrichmentConfigurationProperty
Java	software.amazon.awscdk.services.qbusiness.CfnDataSource.DocumentEnrichmentConfigurationProperty
Python	aws_cdk.aws_qbusiness.CfnDataSource.DocumentEnrichmentConfigurationProperty
TypeScript	aws-cdk-lib » aws_qbusiness » CfnDataSource » DocumentEnrichmentConfigurationProperty

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

For more information, see Custom document enrichment .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';
const documentEnrichmentConfigurationProperty: qbusiness.CfnDataSource.DocumentEnrichmentConfigurationProperty = {
  inlineConfigurations: [{
    condition: {
      key: 'key',
      operator: 'operator',

      // the properties below are optional
      value: {
        dateValue: 'dateValue',
        longValue: 123,
        stringListValue: ['stringListValue'],
        stringValue: 'stringValue',
      },
    },
    documentContentOperator: 'documentContentOperator',
    target: {
      key: 'key',

      // the properties below are optional
      attributeValueOperator: 'attributeValueOperator',
      value: {
        dateValue: 'dateValue',
        longValue: 123,
        stringListValue: ['stringListValue'],
        stringValue: 'stringValue',
      },
    },
  }],
  postExtractionHookConfiguration: {
    invocationCondition: {
      key: 'key',
      operator: 'operator',

      // the properties below are optional
      value: {
        dateValue: 'dateValue',
        longValue: 123,
        stringListValue: ['stringListValue'],
        stringValue: 'stringValue',
      },
    },
    lambdaArn: 'lambdaArn',
    roleArn: 'roleArn',
    s3BucketName: 's3BucketName',
  },
  preExtractionHookConfiguration: {
    invocationCondition: {
      key: 'key',
      operator: 'operator',

      // the properties below are optional
      value: {
        dateValue: 'dateValue',
        longValue: 123,
        stringListValue: ['stringListValue'],
        stringValue: 'stringValue',
      },
    },
    lambdaArn: 'lambdaArn',
    roleArn: 'roleArn',
    s3BucketName: 's3BucketName',
  },
};

Properties

Name	Type	Description
inlineConfigurations?	IResolvable | (IResolvable | InlineDocumentEnrichmentConfigurationProperty)[]	Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
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.

---

inlineConfigurations?

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-inlineconfigurations

---

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 Using Lambda functions .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-postextractionhookconfiguration

---

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 Using Lambda functions .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-preextractionhookconfiguration