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

Interface CfnDataSourcePropsMixin.ColumnConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourcePropsMixin.ColumnConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static interface CfnDataSourcePropsMixin.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.cfnpropertymixins.services.kendra.*;
 ColumnConfigurationProperty columnConfigurationProperty = ColumnConfigurationProperty.builder()
         .changeDetectingColumns(List.of("changeDetectingColumns"))
         .documentDataColumnName("documentDataColumnName")
         .documentIdColumnName("documentIdColumnName")
         .documentTitleColumnName("documentTitleColumnName")
         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .dateFieldFormat("dateFieldFormat")
                 .indexFieldName("indexFieldName")
                 .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	CfnDataSourcePropsMixin.ColumnConfigurationProperty.Builder	A builder for CfnDataSourcePropsMixin.ColumnConfigurationProperty
static final class	CfnDataSourcePropsMixin.ColumnConfigurationProperty.Jsii$Proxy	An implementation for CfnDataSourcePropsMixin.ColumnConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSourcePropsMixin.ColumnConfigurationProperty.Builder	builder()
default List<String>	getChangeDetectingColumns()	One to five columns that indicate when a document in the database has changed.
default String	getDocumentDataColumnName()	The column that contains the contents of the document.
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty>

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 CfnDataSourcePropsMixin.ColumnConfigurationProperty.Builder builder()

Returns:

a CfnDataSourcePropsMixin.ColumnConfigurationProperty.Builder of CfnDataSourcePropsMixin.ColumnConfigurationProperty