Class CfnDataSourcePropsMixin.ColumnConfigurationProperty

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

Inheritance

object

CfnDataSourcePropsMixin.ColumnConfigurationProperty

Implements

CfnDataSourcePropsMixin.IColumnConfigurationProperty

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.ColumnConfigurationProperty : CfnDataSourcePropsMixin.IColumnConfigurationProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.ColumnConfigurationProperty Implements CfnDataSourcePropsMixin.IColumnConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.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 columnConfigurationProperty = new ColumnConfigurationProperty {
                 ChangeDetectingColumns = new [] { "changeDetectingColumns" },
                 DocumentDataColumnName = "documentDataColumnName",
                 DocumentIdColumnName = "documentIdColumnName",
                 DocumentTitleColumnName = "documentTitleColumnName",
                 FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } }
             };

Synopsis

Constructors

ColumnConfigurationProperty()

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

Properties

ChangeDetectingColumns	One to five columns that indicate when a document in the database has changed.
DocumentDataColumnName	The column that contains the contents of the document.
DocumentIdColumnName	The column that provides the document's identifier.
DocumentTitleColumnName	The column that contains the title of the document.
FieldMappings	An array of objects that map database column names to the corresponding fields in an index.

Constructors

ColumnConfigurationProperty()

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

public ColumnConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.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 columnConfigurationProperty = new ColumnConfigurationProperty {
                 ChangeDetectingColumns = new [] { "changeDetectingColumns" },
                 DocumentDataColumnName = "documentDataColumnName",
                 DocumentIdColumnName = "documentIdColumnName",
                 DocumentTitleColumnName = "documentTitleColumnName",
                 FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } }
             };

Properties

ChangeDetectingColumns

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

public string[]? ChangeDetectingColumns { get; set; }

Property Value

string[]

Remarks

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

DocumentDataColumnName

The column that contains the contents of the document.

public string? DocumentDataColumnName { get; set; }

Property Value

string

Remarks

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

DocumentIdColumnName

The column that provides the document's identifier.

public string? DocumentIdColumnName { get; set; }

Property Value

string

Remarks

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

DocumentTitleColumnName

The column that contains the title of the document.

public string? DocumentTitleColumnName { get; set; }

Property Value

string

Remarks

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

FieldMappings

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

public object? FieldMappings { get; set; }

Property Value

object

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-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-fieldmappings

Type union: either IResolvable or (either IResolvable or CfnDataSourcePropsMixin.IDataSourceToIndexFieldMappingProperty)[]

Implements

CfnDataSourcePropsMixin.IColumnConfigurationProperty