Class CfnFeaturedResultsSet

Resource Type definition for AWS::Kendra::FeaturedResultsSet.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnFeaturedResultsSet

Implements

IInspectable

IFeaturedResultsSetRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFeaturedResultsSet : CfnResource, IInspectable, IFeaturedResultsSetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnFeaturedResultsSet Inherits CfnResource Implements IInspectable, IFeaturedResultsSetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

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

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.AWS.Kendra;

             var cfnFeaturedResultsSet = new CfnFeaturedResultsSet(this, "MyCfnFeaturedResultsSet", new CfnFeaturedResultsSetProps {
                 FeaturedResultsSetName = "featuredResultsSetName",
                 IndexId = "indexId",

                 // the properties below are optional
                 Description = "description",
                 FeaturedDocuments = new [] { new FeaturedDocumentProperty {
                     Id = "id"
                 } },
                 QueryTexts = new [] { "queryTexts" },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnFeaturedResultsSet(Construct, string, ICfnFeaturedResultsSetProps)

Create a new AWS::Kendra::FeaturedResultsSet.

Properties

AttrArn	The Amazon Resource Name (ARN) of the featured results set.
AttrFeaturedResultsSetId	The identifier of the set of featured results.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Resource Type definition for AWS::Kendra::FeaturedResultsSet.
CfnPropertyNames	Resource Type definition for AWS::Kendra::FeaturedResultsSet.
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.
FeaturedResultsSetRef	A reference to a FeaturedResultsSet resource.
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.

Methods

ArnForFeaturedResultsSet(IFeaturedResultsSetRef)	Resource Type definition for AWS::Kendra::FeaturedResultsSet.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnFeaturedResultsSet(object)	Checks whether the given object is a CfnFeaturedResultsSet.
RenderProperties(IDictionary<string, object>)	Resource Type definition for AWS::Kendra::FeaturedResultsSet.

Constructors

CfnFeaturedResultsSet(Construct, string, ICfnFeaturedResultsSetProps)

Create a new AWS::Kendra::FeaturedResultsSet.

public CfnFeaturedResultsSet(Construct scope, string id, ICfnFeaturedResultsSetProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnFeaturedResultsSetProps

Resource properties.

Remarks

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

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the featured results set.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrFeaturedResultsSetId

The identifier of the set of featured results.

public virtual string AttrFeaturedResultsSetId { get; }

Property Value

string

Remarks

CloudformationAttribute: FeaturedResultsSetId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

ExampleMetadata: fixture=_generated

CfnProperties

Resource Type definition for AWS::Kendra::FeaturedResultsSet.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

ExampleMetadata: fixture=_generated

CfnPropertyNames

Resource Type definition for AWS::Kendra::FeaturedResultsSet.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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

ExampleMetadata: fixture=_generated

Description

A description for the set of featured results.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

FeaturedDocuments

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

public virtual object? FeaturedDocuments { get; set; }

Property Value

object

Remarks

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

FeaturedResultsSetName

A name for the set of featured results.

public virtual string FeaturedResultsSetName { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

FeaturedResultsSetRef

A reference to a FeaturedResultsSet resource.

public virtual IFeaturedResultsSetReference FeaturedResultsSetRef { get; }

Property Value

IFeaturedResultsSetReference

Remarks

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

ExampleMetadata: fixture=_generated

IndexId

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

public virtual string IndexId { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

QueryTexts

A list of queries for featuring results.

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

Property Value

string[]

Remarks

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

ExampleMetadata: fixture=_generated

Status

The current status of the set of featured results.

public virtual string? Status { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

Tags

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

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

Property Value

ICfnTag[]

Remarks

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

ExampleMetadata: fixture=_generated

Methods

ArnForFeaturedResultsSet(IFeaturedResultsSetRef)

Resource Type definition for AWS::Kendra::FeaturedResultsSet.

public static string ArnForFeaturedResultsSet(IFeaturedResultsSetRef resource)

Parameters

resource IFeaturedResultsSetRef

Returns

string

Remarks

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

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.AWS.Kendra;

             var cfnFeaturedResultsSet = new CfnFeaturedResultsSet(this, "MyCfnFeaturedResultsSet", new CfnFeaturedResultsSetProps {
                 FeaturedResultsSetName = "featuredResultsSetName",
                 IndexId = "indexId",

                 // the properties below are optional
                 Description = "description",
                 FeaturedDocuments = new [] { new FeaturedDocumentProperty {
                     Id = "id"
                 } },
                 QueryTexts = new [] { "queryTexts" },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

ExampleMetadata: fixture=_generated

IsCfnFeaturedResultsSet(object)

Checks whether the given object is a CfnFeaturedResultsSet.

public static bool IsCfnFeaturedResultsSet(object x)

Parameters

x object

Returns

bool

Remarks

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

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Resource Type definition for AWS::Kendra::FeaturedResultsSet.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

ExampleMetadata: fixture=_generated

Implements

IInspectable

IFeaturedResultsSetRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2