Class CfnDataSource.DocumentAttributeConditionProperty

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

Inheritance

object

CfnDataSource.DocumentAttributeConditionProperty

Implements

CfnDataSource.IDocumentAttributeConditionProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.QBusiness

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDataSource.DocumentAttributeConditionProperty : CfnDataSource.IDocumentAttributeConditionProperty

Syntax (vb)

Public Class CfnDataSource.DocumentAttributeConditionProperty 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 Q Business can't 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 Q Business then will map your newly created metadata field to your index field.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-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.QBusiness;

             var documentAttributeConditionProperty = new DocumentAttributeConditionProperty {
                 Key = "key",
                 Operator = "operator",

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

Synopsis

Constructors

DocumentAttributeConditionProperty()

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

Properties

Key	The identifier of the document attribute used for the condition.
Operator	The identifier of the document attribute used for the condition.
Value	The value of a document attribute.

Constructors

DocumentAttributeConditionProperty()

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

public DocumentAttributeConditionProperty()

Remarks

You use this with DocumentAttributeTarget to apply the condition.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-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.QBusiness;

             var documentAttributeConditionProperty = new DocumentAttributeConditionProperty {
                 Key = "key",
                 Operator = "operator",

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