interface ConfluencePageToIndexFieldMappingProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins.CfnDataSourcePropsMixin.ConfluencePageToIndexFieldMappingProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskendra/mixins#CfnDataSourcePropsMixin_ConfluencePageToIndexFieldMappingProperty
Java	software.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnDataSourcePropsMixin.ConfluencePageToIndexFieldMappingProperty
Python	aws_cdk.mixins_preview.aws_kendra.mixins.CfnDataSourcePropsMixin.ConfluencePageToIndexFieldMappingProperty
TypeScript	@aws-cdk/mixins-preview » aws_kendra » mixins » CfnDataSourcePropsMixin » ConfluencePageToIndexFieldMappingProperty

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as kendra_mixins } from '@aws-cdk/mixins-preview/aws-kendra';
const confluencePageToIndexFieldMappingProperty: kendra_mixins.CfnDataSourcePropsMixin.ConfluencePageToIndexFieldMappingProperty = {
  dataSourceFieldName: 'dataSourceFieldName',
  dateFieldFormat: 'dateFieldFormat',
  indexFieldName: 'indexFieldName',
};

Properties

Name	Type	Description
dataSourceFieldName?	string	The name of the field in the data source.
dateFieldFormat?	string	The format for date fields in the data source.
indexFieldName?	string	The name of the index field to map to the Confluence data source field.

---

dataSourceFieldName?

Type: string (optional)

The name of the field in the data source.

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

---

dateFieldFormat?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html#cfn-kendra-datasource-confluencepagetoindexfieldmapping-datefieldformat

---

indexFieldName?

Type: string (optional)

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

The index field type must match the Confluence field type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html#cfn-kendra-datasource-confluencepagetoindexfieldmapping-indexfieldname