Class CfnIndex.DocumentMetadataConfigurationProperty

Specifies the properties, such as relevance tuning and searchability, of an index field.

Inheritance

System.Object

CfnIndex.DocumentMetadataConfigurationProperty

Implements

CfnIndex.IDocumentMetadataConfigurationProperty

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.AWS.Kendra.dll

Syntax (csharp)

public class DocumentMetadataConfigurationProperty : Object, CfnIndex.IDocumentMetadataConfigurationProperty

Syntax (vb)

Public Class DocumentMetadataConfigurationProperty
    Inherits Object
    Implements CfnIndex.IDocumentMetadataConfigurationProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.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 documentMetadataConfigurationProperty = new DocumentMetadataConfigurationProperty {
    Name = "name",
    Type = "type",

    // the properties below are optional
    Relevance = new RelevanceProperty {
        Duration = "duration",
        Freshness = false,
        Importance = 123,
        RankOrder = "rankOrder",
        ValueImportanceItems = new [] { new ValueImportanceItemProperty {
            Key = "key",
            Value = 123
        } }
    },
    Search = new SearchProperty {
        Displayable = false,
        Facetable = false,
        Searchable = false,
        Sortable = false
    }
};

Synopsis

Constructors

DocumentMetadataConfigurationProperty()

Properties

Name	The name of the index field.
Relevance	Provides tuning parameters to determine how the field affects the search results.
Search	Provides information about how the field is used during a search.
Type	The data type of the index field.

Constructors

DocumentMetadataConfigurationProperty()

public DocumentMetadataConfigurationProperty()

Properties

Name

The name of the index field.

public string Name { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-name

Relevance

Provides tuning parameters to determine how the field affects the search results.

public object Relevance { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-relevance

Search

Provides information about how the field is used during a search.

public object Search { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-search

Type

The data type of the index field.

public string Type { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-type

Implements

CfnIndex.IDocumentMetadataConfigurationProperty