software.amazon.awscdk.services.kendra

Interface CfnDataSource.DocumentAttributeTargetProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.DocumentAttributeTargetProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=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 Kendra.

For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set 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 Kendra cannot 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 Kendra then will map your newly created metadata field 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.kendra.*;
 DocumentAttributeTargetProperty documentAttributeTargetProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.DocumentAttributeTargetProperty.Builder	builder()
String	getTargetDocumentAttributeKey() The identifier of the target document attribute or metadata field.
default Object	getTargetDocumentAttributeValue() The target value you want to create for the target attribute.
default Object	getTargetDocumentAttributeValueDeletion() `TRUE` to delete the existing target value for your specified target attribute key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTargetDocumentAttributeKey

@Stability(value=Stable)
 @NotNull
String getTargetDocumentAttributeKey()

The identifier of the target document attribute or metadata field.

For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

getTargetDocumentAttributeValue

@Stability(value=Stable)
 @Nullable
default Object getTargetDocumentAttributeValue()

The target value you want to create for the target attribute.

For example, 'Finance' could be the target value for the target attribute key 'Department'.

getTargetDocumentAttributeValueDeletion

@Stability(value=Stable)
 @Nullable
default Object getTargetDocumentAttributeValueDeletion()

`TRUE` to delete the existing target value for your specified target attribute key.

You cannot create a target value and set this to TRUE . To create a target value ( TargetDocumentAttributeValue ), set this to FALSE .

builder

@Stability(value=Stable)
static CfnDataSource.DocumentAttributeTargetProperty.Builder builder()

Returns:

a CfnDataSource.DocumentAttributeTargetProperty.Builder of CfnDataSource.DocumentAttributeTargetProperty