Interface CfnDataSource.IConfluenceSpaceToIndexFieldMappingProperty

Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.AWS.Kendra.dll

Syntax (csharp)

public interface IConfluenceSpaceToIndexFieldMappingProperty

Syntax (vb)

Public Interface IConfluenceSpaceToIndexFieldMappingProperty

Remarks

To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespacetoindexfieldmapping.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 confluenceSpaceToIndexFieldMappingProperty = new ConfluenceSpaceToIndexFieldMappingProperty {
    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 Confluence data source field.

Properties

DataSourceFieldName

The name of the field in the data source.

string DataSourceFieldName { get; }

Property Value

System.String

Remarks

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

DateFieldFormat

The format for date fields in the data source.

virtual string DateFieldFormat { get; }

Property Value

System.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 Confluence data source field.

string IndexFieldName { get; }

Property Value

System.String

Remarks

The index field type must match the Confluence field type.