AWS::Kendra::DataSource ConfluenceSpaceConfiguration - AWS CloudFormation

AWS::Kendra::DataSource ConfluenceSpaceConfiguration

Specifies the configuration for indexing Confluence spaces.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "CrawlArchivedSpaces" : Boolean, "CrawlPersonalSpaces" : Boolean, "ExcludeSpaces" : [ String, ... ], "IncludeSpaces" : [ String, ... ], "SpaceFieldMappings" : [ ConfluenceSpaceToIndexFieldMapping, ... ] }

Properties

CrawlArchivedSpaces

Specifies whether Amazon Kendra should index archived spaces.

Required: No

Type: Boolean

Update requires: No interruption

CrawlPersonalSpaces

Specifies whether Amazon Kendra should index personal spaces. Users 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.

Required: No

Type: Boolean

Update requires: No interruption

ExcludeSpaces

A list of space keys of Confluence spaces. 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.

Required: No

Type: List of String

Update requires: No interruption

IncludeSpaces

A list of space keys for Confluence spaces. 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.

Required: No

Type: List of String

Update requires: No interruption

SpaceFieldMappings

Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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

Required: No

Type: List of ConfluenceSpaceToIndexFieldMapping

Maximum: 4

Update requires: No interruption