AWS::Kendra::DataSource DocumentAttributeTarget
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.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "TargetDocumentAttributeKey" :
String
, "TargetDocumentAttributeValue" :DocumentAttributeValue
, "TargetDocumentAttributeValueDeletion" :Boolean
}
YAML
TargetDocumentAttributeKey:
String
TargetDocumentAttributeValue:DocumentAttributeValue
TargetDocumentAttributeValueDeletion:Boolean
Properties
TargetDocumentAttributeKey
-
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.
Required: Yes
Type: String
Pattern:
[a-zA-Z0-9_][a-zA-Z0-9_-]*
Minimum:
1
Maximum:
200
Update requires: No interruption
TargetDocumentAttributeValue
-
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'.
Required: No
Type: DocumentAttributeValue
Update requires: No interruption
TargetDocumentAttributeValueDeletion
-
TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
. To create a target value (TargetDocumentAttributeValue
), set this toFALSE
.Required: No
Type: Boolean
Update requires: No interruption