CfnFeaturedResultsSetProps Struct
Properties for defining a CfnFeaturedResultsSet.
Example
ts
// 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 cfnFeaturedResultsSetProps: kendra.CfnFeaturedResultsSetProps = {
featuredResultsSetName: 'featuredResultsSetName',
indexId: 'indexId',
// the properties below are optional
description: 'description',
featuredDocuments: [{
id: 'id',
}],
queryTexts: ['queryTexts'],
status: 'status',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description for the set of featured results.
featuredDocumentsoptionalIResolvable | IResolvable | CfnFeaturedResultsSet.FeaturedDocumentProperty[]featured_documentsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FeaturedDocumentProperty]]]featuredDocumentsoptionalIResolvableFeaturedDocumentsoptionalIResolvableFeaturedDocumentsoptionalinterface{}#A list of document IDs for the documents you want to feature at the top of the search results page.
featuredResultsSetNamestringfeatured_results_set_namestrfeaturedResultsSetNameStringFeaturedResultsSetNamestringFeaturedResultsSetName*stringrequired#A name for the set of featured results.
The identifier of the index that you want to use for featuring results.
queryTextsoptionalstring[]query_textsoptionaltyping.List[str]queryTextsoptionalList<String>QueryTextsoptionalstring[]QueryTextsoptional*[]*string#A list of queries for featuring results.
The current status of the set of featured results.
When the value is ACTIVE, featured results are ready for use.