Package software.amazon.awscdk.services.qbusiness

Interface CfnDataSource.DocumentEnrichmentConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.DocumentEnrichmentConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

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

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

For more information, see Custom document enrichment .

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.qbusiness.*;
 DocumentEnrichmentConfigurationProperty documentEnrichmentConfigurationProperty = DocumentEnrichmentConfigurationProperty.builder()
         .inlineConfigurations(List.of(InlineDocumentEnrichmentConfigurationProperty.builder()
                 .condition(DocumentAttributeConditionProperty.builder()
                         .key("key")
                         .operator("operator")
                         // the properties below are optional
                         .value(DocumentAttributeValueProperty.builder()
                                 .dateValue("dateValue")
                                 .longValue(123)
                                 .stringListValue(List.of("stringListValue"))
                                 .stringValue("stringValue")
                                 .build())
                         .build())
                 .documentContentOperator("documentContentOperator")
                 .target(DocumentAttributeTargetProperty.builder()
                         .key("key")
                         // the properties below are optional
                         .attributeValueOperator("attributeValueOperator")
                         .value(DocumentAttributeValueProperty.builder()
                                 .dateValue("dateValue")
                                 .longValue(123)
                                 .stringListValue(List.of("stringListValue"))
                                 .stringValue("stringValue")
                                 .build())
                         .build())
                 .build()))
         .postExtractionHookConfiguration(HookConfigurationProperty.builder()
                 .invocationCondition(DocumentAttributeConditionProperty.builder()
                         .key("key")
                         .operator("operator")
                         // the properties below are optional
                         .value(DocumentAttributeValueProperty.builder()
                                 .dateValue("dateValue")
                                 .longValue(123)
                                 .stringListValue(List.of("stringListValue"))
                                 .stringValue("stringValue")
                                 .build())
                         .build())
                 .lambdaArn("lambdaArn")
                 .roleArn("roleArn")
                 .s3BucketName("s3BucketName")
                 .build())
         .preExtractionHookConfiguration(HookConfigurationProperty.builder()
                 .invocationCondition(DocumentAttributeConditionProperty.builder()
                         .key("key")
                         .operator("operator")
                         // the properties below are optional
                         .value(DocumentAttributeValueProperty.builder()
                                 .dateValue("dateValue")
                                 .longValue(123)
                                 .stringListValue(List.of("stringListValue"))
                                 .stringValue("stringValue")
                                 .build())
                         .build())
                 .lambdaArn("lambdaArn")
                 .roleArn("roleArn")
                 .s3BucketName("s3BucketName")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.DocumentEnrichmentConfigurationProperty.Builder	builder()
default Object	getInlineConfigurations()	Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
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.

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 Q Business.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSource.InlineDocumentEnrichmentConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-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 Using Lambda functions .

Returns union: either IResolvable or CfnDataSource.HookConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-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 Using Lambda functions .

Returns union: either IResolvable or CfnDataSource.HookConfigurationProperty

See Also:

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

builder

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

Returns:

a CfnDataSource.DocumentEnrichmentConfigurationProperty.Builder of CfnDataSource.DocumentEnrichmentConfigurationProperty