Class CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.services.kendra.CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDataSource.ConfluenceSpaceConfigurationProperty>
- Enclosing interface:
CfnDataSource.ConfluenceSpaceConfigurationProperty
@Stability(Stable)
public static final class CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSource.ConfluenceSpaceConfigurationProperty>
A builder for
CfnDataSource.ConfluenceSpaceConfigurationProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.crawlArchivedSpaces
(Boolean crawlArchivedSpaces) crawlArchivedSpaces
(IResolvable crawlArchivedSpaces) crawlPersonalSpaces
(Boolean crawlPersonalSpaces) crawlPersonalSpaces
(IResolvable crawlPersonalSpaces) excludeSpaces
(List<String> excludeSpaces) Sets the value ofCfnDataSource.ConfluenceSpaceConfigurationProperty.getExcludeSpaces()
includeSpaces
(List<String> includeSpaces) Sets the value ofCfnDataSource.ConfluenceSpaceConfigurationProperty.getIncludeSpaces()
spaceFieldMappings
(List<? extends Object> spaceFieldMappings) spaceFieldMappings
(IResolvable spaceFieldMappings)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
crawlArchivedSpaces
@Stability(Stable) public CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder crawlArchivedSpaces(Boolean crawlArchivedSpaces) - Parameters:
crawlArchivedSpaces
-TRUE
to index archived spaces.- Returns:
this
-
crawlArchivedSpaces
@Stability(Stable) public CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder crawlArchivedSpaces(IResolvable crawlArchivedSpaces) - Parameters:
crawlArchivedSpaces
-TRUE
to index archived spaces.- Returns:
this
-
crawlPersonalSpaces
@Stability(Stable) public CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder crawlPersonalSpaces(Boolean crawlPersonalSpaces) - Parameters:
crawlPersonalSpaces
-TRUE
to index personal spaces. 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 .- Returns:
this
-
crawlPersonalSpaces
@Stability(Stable) public CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder crawlPersonalSpaces(IResolvable crawlPersonalSpaces) - Parameters:
crawlPersonalSpaces
-TRUE
to index personal spaces. 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 .- Returns:
this
-
excludeSpaces
@Stability(Stable) public CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder excludeSpaces(List<String> excludeSpaces) Sets the value ofCfnDataSource.ConfluenceSpaceConfigurationProperty.getExcludeSpaces()
- Parameters:
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 theExcludeSpaces
and theIncludeSpaces
list, the space is excluded.- Returns:
this
-
includeSpaces
@Stability(Stable) public CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder includeSpaces(List<String> includeSpaces) Sets the value ofCfnDataSource.ConfluenceSpaceConfigurationProperty.getIncludeSpaces()
- Parameters:
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 theIncludeSpaces
and theExcludeSpaces
list, the space is excluded.- Returns:
this
-
spaceFieldMappings
@Stability(Stable) public CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder spaceFieldMappings(IResolvable spaceFieldMappings) - Parameters:
spaceFieldMappings
- Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
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.- Returns:
this
-
spaceFieldMappings
@Stability(Stable) public CfnDataSource.ConfluenceSpaceConfigurationProperty.Builder spaceFieldMappings(List<? extends Object> spaceFieldMappings) - Parameters:
spaceFieldMappings
- Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
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.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDataSource.ConfluenceSpaceConfigurationProperty>
- Returns:
- a new instance of
CfnDataSource.ConfluenceSpaceConfigurationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-