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

Interface CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty.Jsii$Proxy

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static interface CfnDataSourcePropsMixin.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.cfnpropertymixins.services.kendra.*;
 DataSourceToIndexFieldMappingProperty dataSourceToIndexFieldMappingProperty = DataSourceToIndexFieldMappingProperty.builder()
         .dataSourceFieldName("dataSourceFieldName")
         .dateFieldFormat("dateFieldFormat")
         .indexFieldName("indexFieldName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty.Builder	builder()
default String	getDataSourceFieldName()	The name of the field in the data source.
default String	getDateFieldFormat()	The format for date fields in the data source.
default String	getIndexFieldName()	The name of the index field to map to the data source field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSourceFieldName

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

The name of the field in the data source.

You must first create the index field using the UpdateIndex API.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-datasourcefieldname

getDateFieldFormat

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

The format for date fields in the data source.

If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-datefieldformat

getIndexFieldName

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

The name of the index field to map to the data source field.

The index field type must match the data source field type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-indexfieldname

builder

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

Returns:

a CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty.Builder of CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty