Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Interface CfnIndexPropsMixin.DocumentMetadataConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndexPropsMixin.DocumentMetadataConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIndexPropsMixin

@Stability(Stable)
public static interface CfnIndexPropsMixin.DocumentMetadataConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the properties, such as relevance tuning and searchability, of an index field.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.kendra.*;
 DocumentMetadataConfigurationProperty documentMetadataConfigurationProperty = DocumentMetadataConfigurationProperty.builder()
         .name("name")
         .relevance(RelevanceProperty.builder()
                 .duration("duration")
                 .freshness(false)
                 .importance(123)
                 .rankOrder("rankOrder")
                 .valueImportanceItems(List.of(ValueImportanceItemProperty.builder()
                         .key("key")
                         .value(123)
                         .build()))
                 .build())
         .search(SearchProperty.builder()
                 .displayable(false)
                 .facetable(false)
                 .searchable(false)
                 .sortable(false)
                 .build())
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIndexPropsMixin.DocumentMetadataConfigurationProperty.Builder	A builder for CfnIndexPropsMixin.DocumentMetadataConfigurationProperty
static final class	CfnIndexPropsMixin.DocumentMetadataConfigurationProperty.Jsii$Proxy	An implementation for CfnIndexPropsMixin.DocumentMetadataConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnIndexPropsMixin.DocumentMetadataConfigurationProperty.Builder	builder()
default String	getName()	The name of the index field.
default Object	getRelevance()	Provides tuning parameters to determine how the field affects the search results.
default Object	getSearch()	Provides information about how the field is used during a search.
default String	getType()	The data type of the index field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the index field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-name

getRelevance

@Stability(Stable)
@Nullable
default Object getRelevance()

Provides tuning parameters to determine how the field affects the search results.

Returns union: either IResolvable or CfnIndexPropsMixin.RelevanceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-relevance

getSearch

@Stability(Stable)
@Nullable
default Object getSearch()

Provides information about how the field is used during a search.

Returns union: either IResolvable or CfnIndexPropsMixin.SearchProperty

See Also:

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

getType

@Stability(Stable)
@Nullable
default String getType()

The data type of the index field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-type

builder

@Stability(Stable)
static CfnIndexPropsMixin.DocumentMetadataConfigurationProperty.Builder builder()

Returns:

a CfnIndexPropsMixin.DocumentMetadataConfigurationProperty.Builder of CfnIndexPropsMixin.DocumentMetadataConfigurationProperty