CfnFeaturedResultsSetProps

class aws_cdk.aws_kendra.CfnFeaturedResultsSetProps(*, featured_results_set_name, index_id, description=None, featured_documents=None, query_texts=None, status=None, tags=None)

Bases: object

Properties for defining a CfnFeaturedResultsSet.

Parameters:

featured_results_set_name (str) – A name for the set of featured results.
index_id (str) – The identifier of the index that you want to use for featuring results.
description (Optional[str]) – A description for the set of featured results.
featured_documents (Union[IResolvable, Sequence[Union[IResolvable, FeaturedDocumentProperty, Dict[str, Any]]], None]) – A list of document IDs for the documents you want to feature at the top of the search results page.
query_texts (Optional[Sequence[str]]) – A list of queries for featuring results.
status (Optional[str]) – The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of key-value pairs that identify or categorize the featured results set.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

cfn_featured_results_set_props = kendra.CfnFeaturedResultsSetProps(
    featured_results_set_name="featuredResultsSetName",
    index_id="indexId",

    # the properties below are optional
    description="description",
    featured_documents=[kendra.CfnFeaturedResultsSet.FeaturedDocumentProperty(
        id="id"
    )],
    query_texts=["queryTexts"],
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)