Interface CfnDataSourcePropsMixin.IConfluenceAttachmentConfigurationProperty

Configuration of attachment settings for the Confluence data source.

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

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnDataSourcePropsMixin.IConfluenceAttachmentConfigurationProperty

Syntax (vb)

Public Interface CfnDataSourcePropsMixin.IConfluenceAttachmentConfigurationProperty

Remarks

Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmentconfiguration.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 confluenceAttachmentConfigurationProperty = new ConfluenceAttachmentConfigurationProperty {
                 AttachmentFieldMappings = new [] { new ConfluenceAttachmentToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } },
                 CrawlAttachments = false
             };

Synopsis

Properties

AttachmentFieldMappings	Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
CrawlAttachments	TRUE to index attachments of pages and blogs in Confluence.

Properties

AttachmentFieldMappings

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

object? AttachmentFieldMappings { get; }

Property Value

object

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.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

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

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

CrawlAttachments

TRUE to index attachments of pages and blogs in Confluence.

object? CrawlAttachments { get; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable