Class CfnFeaturedResultsSetMixinProps

Properties for CfnFeaturedResultsSetPropsMixin.

Inheritance

object

CfnFeaturedResultsSetMixinProps

Implements

ICfnFeaturedResultsSetMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Kendra

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnFeaturedResultsSetMixinProps : ICfnFeaturedResultsSetMixinProps

Syntax (vb)

Public Class CfnFeaturedResultsSetMixinProps Implements ICfnFeaturedResultsSetMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Kendra;

             var cfnFeaturedResultsSetMixinProps = new CfnFeaturedResultsSetMixinProps {
                 Description = "description",
                 FeaturedDocuments = new [] { new FeaturedDocumentProperty {
                     Id = "id"
                 } },
                 FeaturedResultsSetName = "featuredResultsSetName",
                 IndexId = "indexId",
                 QueryTexts = new [] { "queryTexts" },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnFeaturedResultsSetMixinProps()

Properties for CfnFeaturedResultsSetPropsMixin.

Properties

Description	A description for the set of featured results.
FeaturedDocuments	A list of document IDs for the documents you want to feature at the top of the search results page.
FeaturedResultsSetName	A name for the set of featured results.
IndexId	The identifier of the index that you want to use for featuring results.
QueryTexts	A list of queries for featuring results.
Status	The current status of the set of featured results.
Tags	A list of key-value pairs that identify or categorize the featured results set.

Constructors

CfnFeaturedResultsSetMixinProps()

Properties for CfnFeaturedResultsSetPropsMixin.

public CfnFeaturedResultsSetMixinProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Kendra;

             var cfnFeaturedResultsSetMixinProps = new CfnFeaturedResultsSetMixinProps {
                 Description = "description",
                 FeaturedDocuments = new [] { new FeaturedDocumentProperty {
                     Id = "id"
                 } },
                 FeaturedResultsSetName = "featuredResultsSetName",
                 IndexId = "indexId",
                 QueryTexts = new [] { "queryTexts" },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

Description

A description for the set of featured results.

public string? Description { get; set; }

Property Value

string

Remarks

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

FeaturedDocuments

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

public object? FeaturedDocuments { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnFeaturedResultsSetPropsMixin.IFeaturedDocumentProperty)[]

FeaturedResultsSetName

A name for the set of featured results.

public string? FeaturedResultsSetName { get; set; }

Property Value

string

Remarks

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

IndexId

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

public string? IndexId { get; set; }

Property Value

string

Remarks

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

QueryTexts

A list of queries for featuring results.

public string[]? QueryTexts { get; set; }

Property Value

string[]

Remarks

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

Status

The current status of the set of featured results.

public string? Status { get; set; }

Property Value

string

Remarks

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

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

Tags

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

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

Implements

ICfnFeaturedResultsSetMixinProps