software.amazon.awscdk.services.kendra

Interface CfnDataSource.CustomDocumentEnrichmentConfigurationProperty

All Known Implementing Classes:

CfnDataSource.CustomDocumentEnrichmentConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

public static interface 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 software.amazon.awscdk.services.kendra.*;
 CustomDocumentEnrichmentConfigurationProperty customDocumentEnrichmentConfigurationProperty = CustomDocumentEnrichmentConfigurationProperty.builder()
         .inlineConfigurations(List.of(InlineCustomDocumentEnrichmentConfigurationProperty.builder()
                 .condition(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())
                 .documentContentDeletion(false)
                 .target(DocumentAttributeTargetProperty.builder()
                         .targetDocumentAttributeKey("targetDocumentAttributeKey")
                         // the properties below are optional
                         .targetDocumentAttributeValue(DocumentAttributeValueProperty.builder()
                                 .dateValue("dateValue")
                                 .longValue(123)
                                 .stringListValue(List.of("stringListValue"))
                                 .stringValue("stringValue")
                                 .build())
                         .targetDocumentAttributeValueDeletion(false)
                         .build())
                 .build()))
         .postExtractionHookConfiguration(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())
         .preExtractionHookConfiguration(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())
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.CustomDocumentEnrichmentConfigurationProperty.Builder	builder()
default java.lang.Object	getInlineConfigurations() Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
default java.lang.Object	getPostExtractionHookConfiguration() Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted.
default java.lang.Object	getPreExtractionHookConfiguration() Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text.
default java.lang.String	getRoleArn() 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.

Method Detail

getInlineConfigurations

default java.lang.Object getInlineConfigurations()

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

getPostExtractionHookConfiguration

default java.lang.Object getPostExtractionHookConfiguration()

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 .

getPreExtractionHookConfiguration

default java.lang.Object getPreExtractionHookConfiguration()

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 .

getRoleArn

default java.lang.String getRoleArn()

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 .

builder

static CfnDataSource.CustomDocumentEnrichmentConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.CustomDocumentEnrichmentConfigurationProperty.Builder of CfnDataSource.CustomDocumentEnrichmentConfigurationProperty