AWS::Kendra::FeaturedResultsSet

Kendra FeaturedResultsSet

Resource Type definition for AWS::Kendra::FeaturedResultsSet. A set of featured results that are displayed at the top of your search results. Featured results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Properties

7 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
FeaturedResultsSetName
string
Required
IndexId
string
RequiredCreate-only
Description
string
FeaturedDocuments
Array<FeaturedDocument>
Write-only
QueryTexts
Array<string>
Status
string
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the featured results set.
FeaturedResultsSetIdstringThe identifier of the set of featured results.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Kendra::FeaturedResultsSet

Resources:
  MyResource:
    Type: AWS::Kendra::FeaturedResultsSet
    Properties:
      IndexId: "my-indexid"
      FeaturedResultsSetName: "my-featuredresultssetname"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

kendra:CreateFeaturedResultsSetkendra:DescribeFeaturedResultsSetkendra:TagResource

read

kendra:DescribeFeaturedResultsSetkendra:ListTagsForResource

update

kendra:UpdateFeaturedResultsSetkendra:DescribeFeaturedResultsSetkendra:TagResourcekendra:UntagResourcekendra:ListTagsForResource

delete

kendra:BatchDeleteFeaturedResultsSetkendra:DescribeFeaturedResultsSetkendra:ListTagsForResource

list

kendra:ListFeaturedResultsSets

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceKendra
Properties9
Required2
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

IndexId

Related Resources

External Links