Class CfnDataSource.DocumentAttributeConditionProperty

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.

Inheritance

System.Object

CfnDataSource.DocumentAttributeConditionProperty

Implements

CfnDataSource.IDocumentAttributeConditionProperty

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class DocumentAttributeConditionProperty : Object, CfnDataSource.IDocumentAttributeConditionProperty

Syntax (vb)

Public Class DocumentAttributeConditionProperty
    Inherits Object
    Implements CfnDataSource.IDocumentAttributeConditionProperty

Remarks

You use this with DocumentAttributeTarget to apply the condition .

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributecondition.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 documentAttributeConditionProperty = new DocumentAttributeConditionProperty {
    ConditionDocumentAttributeKey = "conditionDocumentAttributeKey",
    Operator = "operator",

    // the properties below are optional
    ConditionOnValue = new DocumentAttributeValueProperty {
        DateValue = "dateValue",
        LongValue = 123,
        StringListValue = new [] { "stringListValue" },
        StringValue = "stringValue"
    }
};

Synopsis

Constructors

DocumentAttributeConditionProperty()

Properties

ConditionDocumentAttributeKey	The identifier of the document attribute used for the condition.
ConditionOnValue	The value used by the operator.
Operator	The condition operator.

Constructors

DocumentAttributeConditionProperty()

public DocumentAttributeConditionProperty()

Properties

ConditionDocumentAttributeKey

The identifier of the document attribute used for the condition.

public string ConditionDocumentAttributeKey { get; set; }

Property Value

System.String

Remarks

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

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

ConditionOnValue

The value used by the operator.

public object ConditionOnValue { get; set; }

Property Value

System.Object

Remarks

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

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

Operator

The condition operator.

public string Operator { get; set; }

Property Value

System.String

Remarks

For example, you can use 'Contains' to partially match a string.

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

Implements

CfnDataSource.IDocumentAttributeConditionProperty