class CfnFeaturedResultsSetPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Kendra.CfnFeaturedResultsSetPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awskendra#CfnFeaturedResultsSetPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.kendra.CfnFeaturedResultsSetPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_kendra.CfnFeaturedResultsSetPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_kendra » CfnFeaturedResultsSetPropsMixin

Implements IMixin

Extends 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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-featuredresultsset.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnFeaturedResultsSetPropsMixin = new kendra.CfnFeaturedResultsSetPropsMixin({
  description: 'description',
  featuredDocuments: [{
    id: 'id',
  }],
  featuredResultsSetName: 'featuredResultsSetName',
  indexId: 'indexId',
  queryTexts: ['queryTexts'],
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnFeaturedResultsSetPropsMixin(props: CfnFeaturedResultsSetMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnFeaturedResultsSetMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnFeaturedResultsSetMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnFeaturedResultsSetMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.