# CfnFeaturedResultsSetProps

Properties for defining a `CfnFeaturedResultsSet`.

Extends: CfnFeaturedResultsSetProps
Used as props by: CfnFeaturedResultsSet

- Source: Generated code
- Type last changed: v2.272.0 · 30 Sep 2026

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

- `description`: string — A description for the set of featured results.

- `featuredDocuments`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnFeaturedResultsSet.FeaturedDocumentProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_kendra.CfnFeaturedResultsSet.FeaturedDocumentProperty.html)[] — A list of document IDs for the documents you want to feature at the top of the search results page.

- `featuredResultsSetName`: string (required) — A name for the set of featured results.

- `indexId`: string (required) — The identifier of the index that you want to use for featuring results.

- `queryTexts`: string[] — A list of queries for featuring results.

- `status`: string — The current status of the set of featured results.

  When the value is ACTIVE, featured results are ready for use.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — A list of key-value pairs that identify or categorize the featured results set.