Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.DataSourceToIndexFieldMappingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.DataSourceToIndexFieldMappingProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.DataSourceToIndexFieldMappingProperty
extends software.amazon.jsii.JsiiSerializable

Maps a column or attribute in the data source to an index field.

You must first create the fields in the index using the UpdateIndex operation.

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.*;
 DataSourceToIndexFieldMappingProperty dataSourceToIndexFieldMappingProperty = DataSourceToIndexFieldMappingProperty.builder()
         .dataSourceFieldName("dataSourceFieldName")
         .indexFieldName("indexFieldName")
         // the properties below are optional
         .dateFieldFormat("dateFieldFormat")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.DataSourceToIndexFieldMappingProperty.Builder	builder()
String	getDataSourceFieldName()	The name of the column or attribute in the data source.
default String	getDateFieldFormat()	The type of data stored in the column or attribute.
String	getIndexFieldName()	The name of the field in the index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSourceFieldName

@Stability(Stable)
@NotNull
String getDataSourceFieldName()

The name of the column or attribute in the data source.

getIndexFieldName

@Stability(Stable)
@NotNull
String getIndexFieldName()

The name of the field in the index.

getDateFieldFormat

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

The type of data stored in the column or attribute.

builder

@Stability(Stable)
static CfnDataSource.DataSourceToIndexFieldMappingProperty.Builder builder()

Returns:

a CfnDataSource.DataSourceToIndexFieldMappingProperty.Builder of CfnDataSource.DataSourceToIndexFieldMappingProperty