aws-cdk-lib.aws_kendra.CfnIndex.SearchProperty

interface SearchProperty

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

Provides information about how a custom index field is used during a search.

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 searchProperty: kendra.CfnIndex.SearchProperty = {
  displayable: false,
  facetable: false,
  searchable: false,
  sortable: false,
};

Properties

NameTypeDescription
displayable?boolean | IResolvableDetermines whether the field is returned in the query response.
facetable?boolean | IResolvableIndicates that the field can be used to create search facets, a count of results for each value in the field.
searchable?boolean | IResolvableDetermines whether the field is used in the search.
sortable?boolean | IResolvableDetermines whether the field can be used to sort the results of a query.

displayable?

Type: boolean | IResolvable (optional)

Determines whether the field is returned in the query response.

The default is true .


facetable?

Type: boolean | IResolvable (optional)

Indicates that the field can be used to create search facets, a count of results for each value in the field.

The default is false .


searchable?

Type: boolean | IResolvable (optional)

Determines whether the field is used in the search.

If the Searchable field is true , you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.


sortable?

Type: boolean | IResolvable (optional)

Determines whether the field can be used to sort the results of a query.

The default is false .