Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.ColumnConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ColumnConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

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

Provides information about how Amazon Kendra should use the columns of a database in an index.

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.*;
 ColumnConfigurationProperty columnConfigurationProperty = ColumnConfigurationProperty.builder()
         .changeDetectingColumns(List.of("changeDetectingColumns"))
         .documentDataColumnName("documentDataColumnName")
         .documentIdColumnName("documentIdColumnName")
         // the properties below are optional
         .documentTitleColumnName("documentTitleColumnName")
         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .indexFieldName("indexFieldName")
                 // the properties below are optional
                 .dateFieldFormat("dateFieldFormat")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.ColumnConfigurationProperty.Builder	builder()
List<String>	getChangeDetectingColumns()	One to five columns that indicate when a document in the database has changed.
String	getDocumentDataColumnName()	The column that contains the contents of the document.
String	getDocumentIdColumnName()	The column that provides the document's identifier.
default String	getDocumentTitleColumnName()	The column that contains the title of the document.
default Object	getFieldMappings()	An array of objects that map database column names to the corresponding fields in an index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChangeDetectingColumns

@Stability(Stable)
@NotNull
List<String> getChangeDetectingColumns()

One to five columns that indicate when a document in the database has changed.

See Also:

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

getDocumentDataColumnName

@Stability(Stable)
@NotNull
String getDocumentDataColumnName()

The column that contains the contents of the document.

See Also:

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

getDocumentIdColumnName

@Stability(Stable)
@NotNull
String getDocumentIdColumnName()

The column that provides the document's identifier.

See Also:

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

getDocumentTitleColumnName

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

The column that contains the title of the document.

See Also:

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

getFieldMappings

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

An array of objects that map database column names to the corresponding fields in an index.

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

See Also:

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

builder

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

Returns:

a CfnDataSource.ColumnConfigurationProperty.Builder of CfnDataSource.ColumnConfigurationProperty