aws-cdk-lib.aws_kendra.CfnIndex.DocumentMetadataConfigurationProperty

interface DocumentMetadataConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnIndex.DocumentMetadataConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnIndex_DocumentMetadataConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnIndex.DocumentMetadataConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnIndex.DocumentMetadataConfigurationProperty
TypeScript aws-cdk-lib » aws_kendra » CfnIndex » DocumentMetadataConfigurationProperty

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const documentMetadataConfigurationProperty: kendra.CfnIndex.DocumentMetadataConfigurationProperty = {
  name: 'name',
  type: 'type',

  // the properties below are optional
  relevance: {
    duration: 'duration',
    freshness: false,
    importance: 123,
    rankOrder: 'rankOrder',
    valueImportanceItems: [{
      key: 'key',
      value: 123,
    }],
  },
  search: {
    displayable: false,
    facetable: false,
    searchable: false,
    sortable: false,
  },
};

Properties

NameTypeDescription
namestringThe name of the index field.
typestringThe data type of the index field.
relevance?IResolvable | RelevancePropertyProvides tuning parameters to determine how the field affects the search results.
search?IResolvable | SearchPropertyProvides information about how the field is used during a search.

name

Type: string

The name of the index field.


type

Type: string

The data type of the index field.


relevance?

Type: IResolvable | RelevanceProperty (optional)

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


search?

Type: IResolvable | SearchProperty (optional)

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