Interface CfnDataSource.IDataSourceToIndexFieldMappingProperty

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

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnDataSource.IDataSourceToIndexFieldMappingProperty

Syntax (vb)

Public Interface CfnDataSource.IDataSourceToIndexFieldMappingProperty

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Kendra;

             var dataSourceToIndexFieldMappingProperty = new DataSourceToIndexFieldMappingProperty {
                 DataSourceFieldName = "dataSourceFieldName",
                 IndexFieldName = "indexFieldName",

                 // the properties below are optional
                 DateFieldFormat = "dateFieldFormat"
             };

Synopsis

Properties

DataSourceFieldName	The name of the field in the data source.
DateFieldFormat	The format for date fields in the data source.
IndexFieldName	The name of the index field to map to the data source field.

Properties

DataSourceFieldName

The name of the field in the data source.

string DataSourceFieldName { get; }

Property Value

string

Remarks

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

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

DateFieldFormat

The format for date fields in the data source.

string? DateFieldFormat { get; }

Property Value

string

Remarks

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.

IndexFieldName

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

string IndexFieldName { get; }

Property Value

string

Remarks

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