Package software.amazon.awscdk.services.kendra

Interface CfnIndex.DocumentMetadataConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.DocumentMetadataConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIndex

@Stability(Stable)
public static interface CfnIndex.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.services.kendra.*;
 DocumentMetadataConfigurationProperty documentMetadataConfigurationProperty = DocumentMetadataConfigurationProperty.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .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())
         .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	CfnIndex.DocumentMetadataConfigurationProperty.Builder	A builder for CfnIndex.DocumentMetadataConfigurationProperty
static final class	CfnIndex.DocumentMetadataConfigurationProperty.Jsii$Proxy	An implementation for CfnIndex.DocumentMetadataConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnIndex.DocumentMetadataConfigurationProperty.Builder	builder()
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.
String	getType()	The data type of the index field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
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

getType

@Stability(Stable)
@NotNull
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

getRelevance

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

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

Returns union: either IResolvable or CfnIndex.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 CfnIndex.SearchProperty

See Also:

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

builder

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

Returns:

a CfnIndex.DocumentMetadataConfigurationProperty.Builder of CfnIndex.DocumentMetadataConfigurationProperty