CfnFeaturedResultsSetPropsMixin

class aws_cdk.cfn_property_mixins.aws_kendra.CfnFeaturedResultsSetPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html
CloudformationResource:: AWS::Kendra::FeaturedResultsSet
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_featured_results_set_props_mixin = kendra.CfnFeaturedResultsSetPropsMixin(kendra.CfnFeaturedResultsSetMixinProps(
    description="description",
    featured_documents=[kendra.CfnFeaturedResultsSetPropsMixin.FeaturedDocumentProperty(
        id="id"
    )],
    featured_results_set_name="featuredResultsSetName",
    index_id="indexId",
    query_texts=["queryTexts"],
    status="status",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Kendra::FeaturedResultsSet.

Parameters:

props (Union[CfnFeaturedResultsSetMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'featuredDocuments', 'featuredResultsSetName', 'indexId', 'queryTexts', 'status', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

FeaturedDocumentProperty

class CfnFeaturedResultsSetPropsMixin.FeaturedDocumentProperty(*, id=None)

Bases: object

A featured document.

This document is displayed at the top of the search results page.

Parameters:: id (Optional[str]) – The identifier of the document to feature in the search results.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-featuredresultsset-featureddocument.html
ExampleMetadata:: fixture=_generated

Example:

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

featured_document_property = kendra.CfnFeaturedResultsSetPropsMixin.FeaturedDocumentProperty(
    id="id"
)

Attributes

id

The identifier of the document to feature in the search results.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-featuredresultsset-featureddocument.html#cfn-kendra-featuredresultsset-featureddocument-id