interface CfnFeaturedResultsSetProps

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnFeaturedResultsSetProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnFeaturedResultsSetProps`
Java	`software.amazon.awscdk.services.kendra.CfnFeaturedResultsSetProps`
Python	`aws_cdk.aws_kendra.CfnFeaturedResultsSetProps`
TypeScript	`aws-cdk-lib` » `aws_kendra` » `CfnFeaturedResultsSetProps`

Properties for defining a CfnFeaturedResultsSet.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html

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 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

Name	Type	Description
featuredResultsSetName	`string`	A name for the set of featured results.
indexId	`string`	The identifier of the index that you want to use for featuring results.
description?	`string`	A description for the set of featured results.
featuredDocuments?	`IResolvable` `\| (IResolvable` `\|` `FeaturedDocumentProperty)[]`	A list of document IDs for the documents you want to feature at the top of the search results page.
queryTexts?	`string[]`	A list of queries for featuring results.
status?	`string`	The current status of the set of featured results.
tags?	`CfnTag[]`	A list of key-value pairs that identify or categorize the featured results set.