com.pulumi.awsnative.kendra.kotlin.inputs.DataSourceConfluenceSpaceConfigurationArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.kendra.kotlin.inputs
import com.pulumi.awsnative.kendra.inputs.DataSourceConfluenceSpaceConfigurationArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
*
* @property crawlArchivedSpaces `TRUE` to index archived spaces.
* @property 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](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) .
* @property 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.
* @property 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.
* @property spaceFieldMappings Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
*/
public data class DataSourceConfluenceSpaceConfigurationArgs(
public val crawlArchivedSpaces: Output? = null,
public val crawlPersonalSpaces: Output? = null,
public val excludeSpaces: Output>? = null,
public val includeSpaces: Output>? = null,
public val spaceFieldMappings: Output>? =
null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.kendra.inputs.DataSourceConfluenceSpaceConfigurationArgs =
com.pulumi.awsnative.kendra.inputs.DataSourceConfluenceSpaceConfigurationArgs.builder()
.crawlArchivedSpaces(crawlArchivedSpaces?.applyValue({ args0 -> args0 }))
.crawlPersonalSpaces(crawlPersonalSpaces?.applyValue({ args0 -> args0 }))
.excludeSpaces(excludeSpaces?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.includeSpaces(includeSpaces?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.spaceFieldMappings(
spaceFieldMappings?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> args0.toJava() })
})
}),
).build()
}
/**
* Builder for [DataSourceConfluenceSpaceConfigurationArgs].
*/
@PulumiTagMarker
public class DataSourceConfluenceSpaceConfigurationArgsBuilder internal constructor() {
private var crawlArchivedSpaces: Output? = null
private var crawlPersonalSpaces: Output? = null
private var excludeSpaces: Output>? = null
private var includeSpaces: Output>? = null
private var spaceFieldMappings: Output>? =
null
/**
* @param value `TRUE` to index archived spaces.
*/
@JvmName("jerbbcgtufihaxjw")
public suspend fun crawlArchivedSpaces(`value`: Output) {
this.crawlArchivedSpaces = value
}
/**
* @param value `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](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) .
*/
@JvmName("pqigddkfarvudhst")
public suspend fun crawlPersonalSpaces(`value`: Output) {
this.crawlPersonalSpaces = value
}
/**
* @param value 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.
*/
@JvmName("ewgaavkpubtfjdeb")
public suspend fun excludeSpaces(`value`: Output>) {
this.excludeSpaces = value
}
@JvmName("swjaxhwinrflkrcd")
public suspend fun excludeSpaces(vararg values: Output) {
this.excludeSpaces = Output.all(values.asList())
}
/**
* @param values 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.
*/
@JvmName("jlmvotxnqgxqrfjx")
public suspend fun excludeSpaces(values: List>) {
this.excludeSpaces = Output.all(values)
}
/**
* @param value 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.
*/
@JvmName("dwohaonuokrqiesq")
public suspend fun includeSpaces(`value`: Output>) {
this.includeSpaces = value
}
@JvmName("twguolsudhqyoeon")
public suspend fun includeSpaces(vararg values: Output) {
this.includeSpaces = Output.all(values.asList())
}
/**
* @param values 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.
*/
@JvmName("sueyrppmtqttexmg")
public suspend fun includeSpaces(values: List>) {
this.includeSpaces = Output.all(values)
}
/**
* @param value Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
*/
@JvmName("eqffocpiqttjplcg")
public suspend fun spaceFieldMappings(`value`: Output>) {
this.spaceFieldMappings = value
}
@JvmName("odbtbuqpldghljyq")
public suspend fun spaceFieldMappings(vararg values: Output) {
this.spaceFieldMappings = Output.all(values.asList())
}
/**
* @param values Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
*/
@JvmName("gocaeervqphpafpl")
public suspend fun spaceFieldMappings(values: List>) {
this.spaceFieldMappings = Output.all(values)
}
/**
* @param value `TRUE` to index archived spaces.
*/
@JvmName("bbptxirtxhflnsro")
public suspend fun crawlArchivedSpaces(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.crawlArchivedSpaces = mapped
}
/**
* @param value `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](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) .
*/
@JvmName("lstmntsmoecklvta")
public suspend fun crawlPersonalSpaces(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.crawlPersonalSpaces = mapped
}
/**
* @param value 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.
*/
@JvmName("lqsxchajuauaofxw")
public suspend fun excludeSpaces(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.excludeSpaces = mapped
}
/**
* @param values 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.
*/
@JvmName("amulyckoxmeabfwt")
public suspend fun excludeSpaces(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.excludeSpaces = mapped
}
/**
* @param value 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.
*/
@JvmName("kttvihywoqfiyxis")
public suspend fun includeSpaces(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.includeSpaces = mapped
}
/**
* @param values 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.
*/
@JvmName("yuvrurqxbwegmhpm")
public suspend fun includeSpaces(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.includeSpaces = mapped
}
/**
* @param value Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
*/
@JvmName("vevwsfskkjdqfvet")
public suspend fun spaceFieldMappings(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.spaceFieldMappings = mapped
}
/**
* @param argument Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
*/
@JvmName("mbblbusihtwmqhof")
public suspend fun spaceFieldMappings(argument: List Unit>) {
val toBeMapped = argument.toList().map {
DataSourceConfluenceSpaceToIndexFieldMappingArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.spaceFieldMappings = mapped
}
/**
* @param argument Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
*/
@JvmName("fvhvtiffyxngtqof")
public suspend fun spaceFieldMappings(vararg argument: suspend DataSourceConfluenceSpaceToIndexFieldMappingArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
DataSourceConfluenceSpaceToIndexFieldMappingArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.spaceFieldMappings = mapped
}
/**
* @param argument Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
*/
@JvmName("mveiuevyqejxgcix")
public suspend fun spaceFieldMappings(argument: suspend DataSourceConfluenceSpaceToIndexFieldMappingArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
DataSourceConfluenceSpaceToIndexFieldMappingArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.spaceFieldMappings = mapped
}
/**
* @param values Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
*/
@JvmName("ifkukbfgufecbsjo")
public suspend fun spaceFieldMappings(vararg values: DataSourceConfluenceSpaceToIndexFieldMappingArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.spaceFieldMappings = mapped
}
internal fun build(): DataSourceConfluenceSpaceConfigurationArgs =
DataSourceConfluenceSpaceConfigurationArgs(
crawlArchivedSpaces = crawlArchivedSpaces,
crawlPersonalSpaces = crawlPersonalSpaces,
excludeSpaces = excludeSpaces,
includeSpaces = includeSpaces,
spaceFieldMappings = spaceFieldMappings,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy