1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. kendra
  6. FeaturedResultsSet

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi

    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.

    Create FeaturedResultsSet Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FeaturedResultsSet(name: string, args: FeaturedResultsSetArgs, opts?: CustomResourceOptions);
    @overload
    def FeaturedResultsSet(resource_name: str,
                           args: FeaturedResultsSetArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def FeaturedResultsSet(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           index_id: Optional[str] = None,
                           description: Optional[str] = None,
                           featured_documents: Optional[Sequence[FeaturedResultsSetFeaturedDocumentArgs]] = None,
                           featured_results_set_name: Optional[str] = None,
                           query_texts: Optional[Sequence[str]] = None,
                           status: Optional[FeaturedResultsSetStatus] = None,
                           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewFeaturedResultsSet(ctx *Context, name string, args FeaturedResultsSetArgs, opts ...ResourceOption) (*FeaturedResultsSet, error)
    public FeaturedResultsSet(string name, FeaturedResultsSetArgs args, CustomResourceOptions? opts = null)
    public FeaturedResultsSet(String name, FeaturedResultsSetArgs args)
    public FeaturedResultsSet(String name, FeaturedResultsSetArgs args, CustomResourceOptions options)
    
    type: aws-native:kendra:FeaturedResultsSet
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_kendra_featured_results_set" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args FeaturedResultsSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FeaturedResultsSetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FeaturedResultsSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FeaturedResultsSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FeaturedResultsSetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    FeaturedResultsSet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FeaturedResultsSet resource accepts the following input properties:

    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 List<Pulumi.AwsNative.Kendra.Inputs.FeaturedResultsSetFeaturedDocument>
    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.
    QueryTexts List<string>
    A list of queries for featuring results.
    Status Pulumi.AwsNative.Kendra.FeaturedResultsSetStatus
    The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs that identify or categorize the featured results set.
    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 []FeaturedResultsSetFeaturedDocumentArgs
    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.
    QueryTexts []string
    A list of queries for featuring results.
    Status FeaturedResultsSetStatus
    The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
    Tags TagArgs
    A list of key-value pairs that identify or categorize the featured results set.
    index_id string
    The identifier of the index that you want to use for featuring results.
    description string
    A description for the set of featured results.
    featured_documents list(object)
    A list of document IDs for the documents you want to feature at the top of the search results page.
    featured_results_set_name string
    A name for the set of featured results.
    query_texts list(string)
    A list of queries for featuring results.
    status "ACTIVE" | "INACTIVE"
    The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
    tags list(object)
    A list of key-value pairs that identify or categorize the featured results set.
    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 List<FeaturedResultsSetFeaturedDocument>
    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.
    queryTexts List<String>
    A list of queries for featuring results.
    status FeaturedResultsSetStatus
    The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
    tags List<Tag>
    A list of key-value pairs that identify or categorize the featured results set.
    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 FeaturedResultsSetFeaturedDocument[]
    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.
    queryTexts string[]
    A list of queries for featuring results.
    status FeaturedResultsSetStatus
    The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
    tags Tag[]
    A list of key-value pairs that identify or categorize the featured results set.
    index_id str
    The identifier of the index that you want to use for featuring results.
    description str
    A description for the set of featured results.
    featured_documents Sequence[FeaturedResultsSetFeaturedDocumentArgs]
    A list of document IDs for the documents you want to feature at the top of the search results page.
    featured_results_set_name str
    A name for the set of featured results.
    query_texts Sequence[str]
    A list of queries for featuring results.
    status FeaturedResultsSetStatus
    The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
    tags Sequence[TagArgs]
    A list of key-value pairs that identify or categorize the featured results set.
    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 List<Property Map>
    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.
    queryTexts List<String>
    A list of queries for featuring results.
    status "ACTIVE" | "INACTIVE"
    The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
    tags List<Property Map>
    A list of key-value pairs that identify or categorize the featured results set.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FeaturedResultsSet resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the featured results set.
    FeaturedResultsSetId string
    The identifier of the set of featured results.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the featured results set.
    FeaturedResultsSetId string
    The identifier of the set of featured results.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the featured results set.
    featured_results_set_id string
    The identifier of the set of featured results.
    id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the featured results set.
    featuredResultsSetId String
    The identifier of the set of featured results.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the featured results set.
    featuredResultsSetId string
    The identifier of the set of featured results.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the featured results set.
    featured_results_set_id str
    The identifier of the set of featured results.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the featured results set.
    featuredResultsSetId String
    The identifier of the set of featured results.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    FeaturedResultsSetFeaturedDocument, FeaturedResultsSetFeaturedDocumentArgs

    A featured document. This document is displayed at the top of the search results page.
    Id string
    The identifier of the document to feature in the search results.
    Id string
    The identifier of the document to feature in the search results.
    id string
    The identifier of the document to feature in the search results.
    id String
    The identifier of the document to feature in the search results.
    id string
    The identifier of the document to feature in the search results.
    id str
    The identifier of the document to feature in the search results.
    id String
    The identifier of the document to feature in the search results.

    FeaturedResultsSetStatus, FeaturedResultsSetStatusArgs

    Active
    ACTIVE
    Inactive
    INACTIVE
    FeaturedResultsSetStatusActive
    ACTIVE
    FeaturedResultsSetStatusInactive
    INACTIVE
    "ACTIVE"
    ACTIVE
    "INACTIVE"
    INACTIVE
    Active
    ACTIVE
    Inactive
    INACTIVE
    Active
    ACTIVE
    Inactive
    INACTIVE
    ACTIVE
    ACTIVE
    INACTIVE
    INACTIVE
    "ACTIVE"
    ACTIVE
    "INACTIVE"
    INACTIVE

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial