interface SearchProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnIndex.SearchProperty`
Java	`software.amazon.awscdk.services.kendra.CfnIndex.SearchProperty`
Python	`aws_cdk.aws_kendra.CfnIndex.SearchProperty`
TypeScript	`@aws-cdk/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 * as kendra from '@aws-cdk/aws-kendra';
const searchProperty: kendra.CfnIndex.SearchProperty = {
  displayable: false,
  facetable: false,
  searchable: false,
  sortable: false,
};

Properties

Name	Type	Description
displayable?	`boolean \|` `IResolvable`	Determines whether the field is returned in the query response.
facetable?	`boolean \|` `IResolvable`	Indicates that the field can be used to create search facets, a count of results for each value in the field.
searchable?	`boolean \|` `IResolvable`	Determines whether the field is used in the search.
sortable?	`boolean \|` `IResolvable`	Determines 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 .