Interface CfnDataSource.IDocumentAttributeTargetProperty

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDocumentAttributeTargetProperty

Syntax (vb)

Public Interface IDocumentAttributeTargetProperty

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributetarget.html

ExampleMetadata: fixture=_generated

Examples

// 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
};

Synopsis

Properties

TargetDocumentAttributeKey	The identifier of the target document attribute or metadata field.
TargetDocumentAttributeValue	The target value you want to create for the target attribute.
TargetDocumentAttributeValueDeletion	`TRUE` to delete the existing target value for your specified target attribute key.

Properties

TargetDocumentAttributeKey

The identifier of the target document attribute or metadata field.

string TargetDocumentAttributeKey { get; }

Property Value

System.String

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributetarget.html#cfn-kendra-datasource-documentattributetarget-targetdocumentattributekey

TargetDocumentAttributeValue

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

virtual object TargetDocumentAttributeValue { get; }

Property Value

System.Object

Remarks

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

TargetDocumentAttributeValueDeletion

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

virtual object TargetDocumentAttributeValueDeletion { get; }

Property Value

System.Object

Remarks

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