Package software.amazon.awscdk.services.kendra

Class CfnFeaturedResultsSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.kendra.CfnFeaturedResultsSet
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IFeaturedResultsSetRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:54.340Z") @Stability(Stable) public class CfnFeaturedResultsSet extends CfnResource implements IInspectable, IFeaturedResultsSetRef, ITaggableV2
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.

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.*;
 CfnFeaturedResultsSet cfnFeaturedResultsSet = CfnFeaturedResultsSet.Builder.create(this, "MyCfnFeaturedResultsSet")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFeaturedResultsSet

      protected CfnFeaturedResultsSet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFeaturedResultsSet

      protected CfnFeaturedResultsSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFeaturedResultsSet

      @Stability(Stable) public CfnFeaturedResultsSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFeaturedResultsSetProps props)
      Create a new AWS::Kendra::FeaturedResultsSet.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForFeaturedResultsSet

      @Stability(Stable) @NotNull public static String arnForFeaturedResultsSet(@NotNull IFeaturedResultsSetRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnFeaturedResultsSet

      @Stability(Stable) @NotNull public static Boolean isCfnFeaturedResultsSet(@NotNull Object x)
      Checks whether the given object is a CfnFeaturedResultsSet.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the featured results set.

    • getAttrFeaturedResultsSetId

      @Stability(Stable) @NotNull public String getAttrFeaturedResultsSetId()
      The identifier of the set of featured results.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getFeaturedResultsSetRef

      @Stability(Stable) @NotNull public FeaturedResultsSetReference getFeaturedResultsSetRef()
      A reference to a FeaturedResultsSet resource.
      Specified by:
      getFeaturedResultsSetRef in interface IFeaturedResultsSetRef

    • getFeaturedResultsSetName

      @Stability(Stable) @NotNull public String getFeaturedResultsSetName()
      A name for the set of featured results.

    • setFeaturedResultsSetName

      @Stability(Stable) public void setFeaturedResultsSetName(@NotNull String value)
      A name for the set of featured results.

    • getIndexId

      @Stability(Stable) @NotNull public String getIndexId()
      The identifier of the index that you want to use for featuring results.

    • setIndexId

      @Stability(Stable) public void setIndexId(@NotNull String value)
      The identifier of the index that you want to use for featuring results.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the set of featured results.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the set of featured results.

    • getFeaturedDocuments

      @Stability(Stable) @Nullable public 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>

    • setFeaturedDocuments

      @Stability(Stable) public void setFeaturedDocuments(@Nullable IResolvable value)
      A list of document IDs for the documents you want to feature at the top of the search results page.

    • setFeaturedDocuments

      @Stability(Stable) public void setFeaturedDocuments(@Nullable List<Object> value)
      A list of document IDs for the documents you want to feature at the top of the search results page.

    • getQueryTexts

      @Stability(Stable) @Nullable public List<String> getQueryTexts()
      A list of queries for featuring results.

    • setQueryTexts

      @Stability(Stable) public void setQueryTexts(@Nullable List<String> value)
      A list of queries for featuring results.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The current status of the set of featured results.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The current status of the set of featured results.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs that identify or categorize the featured results set.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs that identify or categorize the featured results set.