DocumentAttributeTargetProperty Struct
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 .
| Source | |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const documentAttributeTargetProperty: kendra.CfnDataSource.DocumentAttributeTargetProperty = {
targetDocumentAttributeKey: 'targetDocumentAttributeKey',
// the properties below are optional
targetDocumentAttributeValue: {
dateValue: 'dateValue',
longValue: 123,
stringListValue: ['stringListValue'],
stringValue: 'stringValue',
},
targetDocumentAttributeValueDeletion: false,
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra
document_attribute_target_property = kendra.CfnDataSource.DocumentAttributeTargetProperty(
target_document_attribute_key="targetDocumentAttributeKey",
# the properties below are optional
target_document_attribute_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
date_value="dateValue",
long_value=123,
string_list_value=["stringListValue"],
string_value="stringValue"
),
target_document_attribute_value_deletion=False
)
// 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();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var documentAttributeTargetProperty = new DocumentAttributeTargetProperty {
TargetDocumentAttributeKey = "targetDocumentAttributeKey",
// the properties below are optional
TargetDocumentAttributeValue = new DocumentAttributeValueProperty {
DateValue = "dateValue",
LongValue = 123,
StringListValue = new [] { "stringListValue" },
StringValue = "stringValue"
},
TargetDocumentAttributeValueDeletion = false
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
documentAttributeTargetProperty := &DocumentAttributeTargetProperty{
TargetDocumentAttributeKey: jsii.String("targetDocumentAttributeKey"),
// the properties below are optional
TargetDocumentAttributeValue: &DocumentAttributeValueProperty{
DateValue: jsii.String("dateValue"),
LongValue: jsii.Number(123),
StringListValue: []*string{
jsii.String("stringListValue"),
},
StringValue: jsii.String("stringValue"),
},
TargetDocumentAttributeValueDeletion: jsii.Boolean(false),
}
Properties
targetDocumentAttributeKeystringtarget_document_attribute_keystrtargetDocumentAttributeKeyStringTargetDocumentAttributeKeystringTargetDocumentAttributeKey*string required #For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
targetDocumentAttributeValueoptionalIResolvable | CfnDataSource.target_document_attribute_valueoptionaltyping.Union[IResolvable, DocumentAttributeValueProperty]targetDocumentAttributeValueoptionalIResolvableTargetDocumentAttributeValueoptionalIResolvableTargetDocumentAttributeValueoptionalinterface{} #For example, 'Finance' could be the target value for the target attribute key 'Department'.
targetDocumentAttributeValueDeletionoptionalboolean | IResolvabletarget_document_attribute_value_deletionoptionaltyping.Union[bool, IResolvable]targetDocumentAttributeValueDeletionoptionalBooleanTargetDocumentAttributeValueDeletionoptionalboolTargetDocumentAttributeValueDeletionoptionalinterface{} #You cannot create a target value and set this to TRUE . To create a target value ( TargetDocumentAttributeValue ), set this to FALSE .