interface CfnFeaturedResultsSetMixinProps

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.Kendra.CfnFeaturedResultsSetMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awskendra#CfnFeaturedResultsSetMixinProps`
Java	`software.amazon.awscdk.cfnpropertymixins.services.kendra.CfnFeaturedResultsSetMixinProps`
Python	`aws_cdk.cfn_property_mixins.aws_kendra.CfnFeaturedResultsSetMixinProps`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_kendra` » `CfnFeaturedResultsSetMixinProps`

Properties for CfnFeaturedResultsSetPropsMixin.

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/cfn-property-mixins';
const cfnFeaturedResultsSetMixinProps: kendra.CfnFeaturedResultsSetMixinProps = {
  description: 'description',
  featuredDocuments: [{
    id: 'id',
  }],
  featuredResultsSetName: 'featuredResultsSetName',
  indexId: 'indexId',
  queryTexts: ['queryTexts'],
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
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.
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.
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.