Package software.amazon.awscdk.services.qbusiness

Interface CfnDataSource.DocumentAttributeTargetProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDataSource.DocumentAttributeTargetProperty.Jsii$Proxy
Enclosing class:
CfnDataSource
@Stability(Stable) public static interface CfnDataSource.DocumentAttributeTargetProperty extends software.amazon.jsii.JsiiSerializable
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE . This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition .

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.*;
 DocumentAttributeTargetProperty documentAttributeTargetProperty = 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();

See Also: