We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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:
- 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<Pulumi.Aws Native. Kendra. Inputs. Featured Results Set Featured Document> - A list of document IDs for the documents you want to feature at the top of the search results page.
- Featured
Results stringSet Name - A name for the set of featured results.
- Query
Texts List<string> - A list of queries for featuring results.
- Status
Pulumi.
Aws Native. Kendra. Featured Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
-
List<Pulumi.
Aws Native. Inputs. Tag> - 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 []FeaturedResults Set Featured Document Args - A list of document IDs for the documents you want to feature at the top of the search results page.
- Featured
Results stringSet Name - A name for the set of featured results.
- Query
Texts []string - A list of queries for featuring results.
- Status
Featured
Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
-
Tag
Args - 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_ stringset_ name - 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.
- list(object)
- 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<FeaturedResults Set Featured Document> - A list of document IDs for the documents you want to feature at the top of the search results page.
- featured
Results StringSet Name - A name for the set of featured results.
- query
Texts List<String> - A list of queries for featuring results.
- status
Featured
Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
- List<Tag>
- 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 FeaturedResults Set Featured Document[] - A list of document IDs for the documents you want to feature at the top of the search results page.
- featured
Results stringSet Name - A name for the set of featured results.
- query
Texts string[] - A list of queries for featuring results.
- status
Featured
Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
- 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[FeaturedResults Set Featured Document Args] - A list of document IDs for the documents you want to feature at the top of the search results page.
- featured_
results_ strset_ name - A name for the set of featured results.
- query_
texts Sequence[str] - A list of queries for featuring results.
- status
Featured
Results Set Status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
-
Sequence[Tag
Args] - 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<Property Map> - A list of document IDs for the documents you want to feature at the top of the search results page.
- featured
Results StringSet Name - 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.
- 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.
- Featured
Results stringSet Id - 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 stringSet Id - 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_ stringset_ id - 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 StringSet Id - 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 stringSet Id - 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_ strset_ id - 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.
- featured
Results StringSet Id - 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
- Featured
Results Set Status Active ACTIVE- Featured
Results Set Status Inactive 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.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi