Package software.amazon.awscdk.services.kendra

Interface CfnFeaturedResultsSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFeaturedResultsSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:54.341Z")
@Stability(Stable)
public interface CfnFeaturedResultsSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFeaturedResultsSet.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 CfnFeaturedResultsSetProps cfnFeaturedResultsSetProps = CfnFeaturedResultsSetProps.builder()
         .featuredResultsSetName("featuredResultsSetName")
         .indexId("indexId")
         // the properties below are optional
         .description("description")
         .featuredDocuments(List.of(FeaturedDocumentProperty.builder()
                 .id("id")
                 .build()))
         .queryTexts(List.of("queryTexts"))
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFeaturedResultsSetProps.Builder	A builder for CfnFeaturedResultsSetProps
static final class	CfnFeaturedResultsSetProps.Jsii$Proxy	An implementation for CfnFeaturedResultsSetProps

Method Summary

Modifier and Type	Method	Description
static CfnFeaturedResultsSetProps.Builder	builder()
default String	getDescription()	A description for the set of featured results.
default Object	getFeaturedDocuments()	A list of document IDs for the documents you want to feature at the top of the search results page.
String	getFeaturedResultsSetName()	A name for the set of featured results.
String	getIndexId()	The identifier of the index that you want to use for featuring results.
default List<String>	getQueryTexts()	A list of queries for featuring results.
default String	getStatus()	The current status of the set of featured results.
default List<CfnTag>	getTags()	A list of key-value pairs that identify or categorize the featured results set.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFeaturedResultsSetName

@Stability(Stable)
@NotNull
String getFeaturedResultsSetName()

A name for the set of featured results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html#cfn-kendra-featuredresultsset-featuredresultssetname

getIndexId

@Stability(Stable)
@NotNull
String getIndexId()

The identifier of the index that you want to use for featuring results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html#cfn-kendra-featuredresultsset-indexid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the set of featured results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html#cfn-kendra-featuredresultsset-description

getFeaturedDocuments

@Stability(Stable)
@Nullable
default Object getFeaturedDocuments()

A list of document IDs for the documents you want to feature at the top of the search results page.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFeaturedResultsSet.FeaturedDocumentProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html#cfn-kendra-featuredresultsset-featureddocuments

getQueryTexts

@Stability(Stable)
@Nullable
default List<String> getQueryTexts()

A list of queries for featuring results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html#cfn-kendra-featuredresultsset-querytexts

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The current status of the set of featured results.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html#cfn-kendra-featuredresultsset-status

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of key-value pairs that identify or categorize the featured results set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html#cfn-kendra-featuredresultsset-tags

builder

@Stability(Stable)
static CfnFeaturedResultsSetProps.Builder builder()

Returns:

a CfnFeaturedResultsSetProps.Builder of CfnFeaturedResultsSetProps