Class: Aws::Kendra::Types::ConfluenceSpaceConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

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",
    },
  ],
}

Specifies the configuration for indexing Confluence spaces.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#crawl_archived_spacesBoolean

Specifies whether Amazon Kendra should index archived spaces.

Returns:

  • (Boolean)


1688
1689
1690
1691
1692
1693
1694
1695
1696
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1688

class ConfluenceSpaceConfiguration < Struct.new(
  :crawl_personal_spaces,
  :crawl_archived_spaces,
  :include_spaces,
  :exclude_spaces,
  :space_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_personal_spacesBoolean

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.

Returns:

  • (Boolean)


1688
1689
1690
1691
1692
1693
1694
1695
1696
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1688

class ConfluenceSpaceConfiguration < Struct.new(
  :crawl_personal_spaces,
  :crawl_archived_spaces,
  :include_spaces,
  :exclude_spaces,
  :space_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_spacesArray<String>

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.

Returns:

  • (Array<String>)


1688
1689
1690
1691
1692
1693
1694
1695
1696
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1688

class ConfluenceSpaceConfiguration < Struct.new(
  :crawl_personal_spaces,
  :crawl_archived_spaces,
  :include_spaces,
  :exclude_spaces,
  :space_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#include_spacesArray<String>

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.

Returns:

  • (Array<String>)


1688
1689
1690
1691
1692
1693
1694
1695
1696
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1688

class ConfluenceSpaceConfiguration < Struct.new(
  :crawl_personal_spaces,
  :crawl_archived_spaces,
  :include_spaces,
  :exclude_spaces,
  :space_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#space_field_mappingsArray<Types::ConfluenceSpaceToIndexFieldMapping>

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.



1688
1689
1690
1691
1692
1693
1694
1695
1696
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1688

class ConfluenceSpaceConfiguration < Struct.new(
  :crawl_personal_spaces,
  :crawl_archived_spaces,
  :include_spaces,
  :exclude_spaces,
  :space_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end