Class CfnDataSource.ConfluenceSpaceConfigurationProperty
Configuration information for indexing Confluence spaces.
Inheritance
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ConfluenceSpaceConfigurationProperty : Object, CfnDataSource.IConfluenceSpaceConfigurationProperty
Syntax (vb)
Public Class ConfluenceSpaceConfigurationProperty
Inherits Object
Implements CfnDataSource.IConfluenceSpaceConfigurationProperty
Remarks
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 confluenceSpaceConfigurationProperty = new ConfluenceSpaceConfigurationProperty {
CrawlArchivedSpaces = false,
CrawlPersonalSpaces = false,
ExcludeSpaces = new [] { "excludeSpaces" },
IncludeSpaces = new [] { "includeSpaces" },
SpaceFieldMappings = new [] { new ConfluenceSpaceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
};
Synopsis
Constructors
ConfluenceSpaceConfigurationProperty() |
Properties
CrawlArchivedSpaces |
|
CrawlPersonalSpaces |
|
ExcludeSpaces | A list of space keys of Confluence spaces. |
IncludeSpaces | A list of space keys for Confluence spaces. |
SpaceFieldMappings | Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. |
Constructors
ConfluenceSpaceConfigurationProperty()
public ConfluenceSpaceConfigurationProperty()
Properties
CrawlArchivedSpaces
TRUE
to index archived spaces.
public object CrawlArchivedSpaces { get; set; }
Property Value
System.Object
Remarks
CrawlPersonalSpaces
TRUE
to index personal spaces.
public object CrawlPersonalSpaces { get; set; }
Property Value
System.Object
Remarks
You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context .
ExcludeSpaces
A list of space keys of Confluence spaces.
public string[] ExcludeSpaces { get; set; }
Property Value
System.String[]
Remarks
If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces
and the IncludeSpaces
list, the space is excluded.
IncludeSpaces
A list of space keys for Confluence spaces.
public string[] IncludeSpaces { get; set; }
Property Value
System.String[]
Remarks
If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces
and the ExcludeSpaces
list, the space is excluded.
SpaceFieldMappings
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.
public object SpaceFieldMappings { get; set; }
Property Value
System.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 SpaceFieldMappings
parameter, you must specify at least one field mapping.