Class CfnIndexPropsMixin.SearchProperty

Provides information about how a custom index field is used during a search.

Inheritance
object
CfnIndexPropsMixin.SearchProperty
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnIndexPropsMixin.SearchProperty : CfnIndexPropsMixin.ISearchProperty
Syntax (vb)
Public Class CfnIndexPropsMixin.SearchProperty Implements CfnIndexPropsMixin.ISearchProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.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.Mixins.Preview.AWS.Kendra.Mixins;

             var searchProperty = new SearchProperty {
                 Displayable = false,
                 Facetable = false,
                 Searchable = false,
                 Sortable = false
             };

Synopsis

Constructors

SearchProperty()

Provides information about how a custom index field is used during a search.

Properties

Displayable

Determines whether the field is returned in the query response.
Facetable

Indicates that the field can be used to create search facets, a count of results for each value in the field.
Searchable

Determines whether the field is used in the search.
Sortable

Determines whether the field can be used to sort the results of a query.

Constructors

SearchProperty()

Provides information about how a custom index field is used during a search.

public SearchProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.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.Mixins.Preview.AWS.Kendra.Mixins;

             var searchProperty = new SearchProperty {
                 Displayable = false,
                 Facetable = false,
                 Searchable = false,
                 Sortable = false
             };

Properties

Displayable

Determines whether the field is returned in the query response.

public object? Displayable { get; set; }
Property Value

object

Remarks

The default is true .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-displayable

Type union: either bool or IResolvable

Facetable

Indicates that the field can be used to create search facets, a count of results for each value in the field.

public object? Facetable { get; set; }
Property Value

object

Remarks

The default is false .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-facetable

Type union: either bool or IResolvable

Searchable

Determines whether the field is used in the search.

public object? Searchable { get; set; }
Property Value

object

Remarks

If the Searchable field is true , you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-searchable

Type union: either bool or IResolvable

Sortable

Determines whether the field can be used to sort the results of a query.

public object? Sortable { get; set; }
Property Value

object

Remarks

The default is false .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-sortable

Type union: either bool or IResolvable

Implements