ConfluencePageToIndexFieldMappingProperty Struct
Maps attributes or field names of Confluence pages to Amazon Kendra index field names.
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.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const confluencePageToIndexFieldMappingProperty: kendra.CfnDataSource.ConfluencePageToIndexFieldMappingProperty = {
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra
confluence_page_to_index_field_mapping_property = kendra.CfnDataSource.ConfluencePageToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;
ConfluencePageToIndexFieldMappingProperty confluencePageToIndexFieldMappingProperty = ConfluencePageToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 confluencePageToIndexFieldMappingProperty = new ConfluencePageToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
confluencePageToIndexFieldMappingProperty := &ConfluencePageToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
}
Properties
dataSourceFieldNamestringdata_source_field_namestrdataSourceFieldNameStringDataSourceFieldNamestringDataSourceFieldName*stringrequired#The name of the field in the data source.
dateFieldFormatoptionalstringdate_field_formatoptionalstrdateFieldFormatoptionalStringDateFieldFormatoptionalstringDateFieldFormatoptional*string#The format for date fields in the data source.
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.
indexFieldNamestringindex_field_namestrindexFieldNameStringIndexFieldNamestringIndexFieldName*stringrequired#The name of the index field to map to the Confluence data source field.
The index field type must match the Confluence field type.