Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.CustomDocumentEnrichmentConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.CustomDocumentEnrichmentConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.CustomDocumentEnrichmentConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.CustomDocumentEnrichmentConfigurationProperty.Builder	builder()
default Object	getInlineConfigurations()	Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
default Object	getPostExtractionHookConfiguration()	Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted.
default 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 String	getRoleArn()	The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInlineConfigurations

@Stability(Stable)
@Nullable
default Object getInlineConfigurations()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-inlineconfigurations

getPostExtractionHookConfiguration

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-postextractionhookconfiguration

getPreExtractionHookConfiguration

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-preextractionhookconfiguration

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

For more information, see an IAM roles for Amazon Kendra .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-rolearn

builder

@Stability(Stable)
static CfnDataSource.CustomDocumentEnrichmentConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.CustomDocumentEnrichmentConfigurationProperty.Builder of CfnDataSource.CustomDocumentEnrichmentConfigurationProperty