class Aws::Kendra::Types::ConfluenceSpaceConfiguration

Specifies the configuration for indexing Confluence spaces.

@note When making an API call, you may pass ConfluenceSpaceConfiguration

data as a hash:

    {
      crawl_personal_spaces: false,
      crawl_archived_spaces: false,
      include_spaces: ["ConfluenceSpaceIdentifier"],
      exclude_spaces: ["ConfluenceSpaceIdentifier"],
      space_field_mappings: [
        {
          data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
          date_field_format: "DataSourceDateFieldFormat",
          index_field_name: "IndexFieldName",
        },
      ],
    }

@!attribute [rw] crawl_personal_spaces

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][1].

[1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
@return [Boolean]

@!attribute [rw] crawl_archived_spaces

Specifies whether Amazon Kendra should index archived spaces.
@return [Boolean]

@!attribute [rw] include_spaces

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.
@return [Array<String>]

@!attribute [rw] exclude_spaces

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.
@return [Array<String>]

@!attribute [rw] space_field_mappings

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.
@return [Array<Types::ConfluenceSpaceToIndexFieldMapping>]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceSpaceConfiguration AWS API Documentation

Constants

SENSITIVE