Class CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty

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

Inheritance

object

CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty

Implements

CfnDataSourcePropsMixin.IDataSourceToIndexFieldMappingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty : CfnDataSourcePropsMixin.IDataSourceToIndexFieldMappingProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty Implements CfnDataSourcePropsMixin.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.Mixins.Preview.AWS.Kendra.Mixins;

             var dataSourceToIndexFieldMappingProperty = new DataSourceToIndexFieldMappingProperty {
                 DataSourceFieldName = "dataSourceFieldName",
                 DateFieldFormat = "dateFieldFormat",
                 IndexFieldName = "indexFieldName"
             };

Synopsis

Constructors

DataSourceToIndexFieldMappingProperty()

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

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.

Constructors

DataSourceToIndexFieldMappingProperty()

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

public DataSourceToIndexFieldMappingProperty()

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.Mixins.Preview.AWS.Kendra.Mixins;

             var dataSourceToIndexFieldMappingProperty = new DataSourceToIndexFieldMappingProperty {
                 DataSourceFieldName = "dataSourceFieldName",
                 DateFieldFormat = "dateFieldFormat",
                 IndexFieldName = "indexFieldName"
             };

Properties

DataSourceFieldName

The name of the field in the data source.

public string? DataSourceFieldName { get; set; }

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.

public string? DateFieldFormat { get; set; }

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.

public string? IndexFieldName { get; set; }

Property Value

string

Remarks

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

Implements

CfnDataSourcePropsMixin.IDataSourceToIndexFieldMappingProperty