Package software.amazon.awscdk.services.qbusiness

Interface CfnDataSource.HookConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.HookConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

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

Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration .

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

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.*;
 HookConfigurationProperty hookConfigurationProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.HookConfigurationProperty.Builder	builder()
default Object	getInvocationCondition()	The condition used for when a Lambda function should be invoked.
default String	getLambdaArn()	The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
default 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.
default String	getS3BucketName()	Stores the original, raw documents or the structured, parsed documents before and after altering them.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInvocationCondition

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

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

See Also:

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

getLambdaArn

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

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.

For more information, see IAM roles for Custom Document Enrichment (CDE) .

See Also:

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

getRoleArn

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

See Also:

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

getS3BucketName

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

Stores the original, raw documents or the structured, parsed documents before and after altering them.

For more information, see Data contracts for Lambda functions .

See Also:

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

builder

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

Returns:

a CfnDataSource.HookConfigurationProperty.Builder of CfnDataSource.HookConfigurationProperty