com.pulumi.awsnative.location.kotlin.PlaceIndexArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.location.kotlin
import com.pulumi.awsnative.kotlin.inputs.TagArgs
import com.pulumi.awsnative.kotlin.inputs.TagArgsBuilder
import com.pulumi.awsnative.location.PlaceIndexArgs.builder
import com.pulumi.awsnative.location.kotlin.enums.PlaceIndexPricingPlan
import com.pulumi.awsnative.location.kotlin.inputs.PlaceIndexDataSourceConfigurationArgs
import com.pulumi.awsnative.location.kotlin.inputs.PlaceIndexDataSourceConfigurationArgsBuilder
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.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Definition of AWS::Location::PlaceIndex Resource Type
* @property dataSource Specifies the geospatial data provider for the new place index.
* > This field is case-sensitive. Enter the valid values as shown. For example, entering `HERE` returns an error.
* Valid values include:
* - `Esri` – For additional information about [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html) 's coverage in your region of interest, see [Esri details on geocoding coverage](https://docs.aws.amazon.com/https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm) .
* - `Grab` – Grab provides place index functionality for Southeast Asia. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/grab.html) ' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area) .
* - `Here` – For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) ' coverage in your region of interest, see [HERE details on goecoding coverage](https://docs.aws.amazon.com/https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html) .
* > If you specify HERE Technologies ( `Here` ) as the data provider, you may not [store results](https://docs.aws.amazon.com//location-places/latest/APIReference/API_DataSourceConfiguration.html) for locations in Japan. For more information, see the [AWS Service Terms](https://docs.aws.amazon.com/service-terms/) for Amazon Location Service.
* For additional information , see [Data providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) on the *Amazon Location Service Developer Guide* .
* @property dataSourceConfiguration Specifies the data storage option requesting Places.
* @property description The optional description for the place index resource.
* @property indexName The name of the place index resource.
* Requirements:
* - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique place index resource name.
* - No spaces allowed. For example, `ExamplePlaceIndex` .
* @property pricingPlan No longer used. If included, the only allowed value is `RequestBasedUsage` .
* *Allowed Values* : `RequestBasedUsage`
* @property tags An array of key-value pairs to apply to this resource.
*/
public data class PlaceIndexArgs(
public val dataSource: Output? = null,
public val dataSourceConfiguration: Output? = null,
public val description: Output? = null,
public val indexName: Output? = null,
public val pricingPlan: Output? = null,
public val tags: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.location.PlaceIndexArgs =
com.pulumi.awsnative.location.PlaceIndexArgs.builder()
.dataSource(dataSource?.applyValue({ args0 -> args0 }))
.dataSourceConfiguration(
dataSourceConfiguration?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.description(description?.applyValue({ args0 -> args0 }))
.indexName(indexName?.applyValue({ args0 -> args0 }))
.pricingPlan(pricingPlan?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.tags(
tags?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
).build()
}
/**
* Builder for [PlaceIndexArgs].
*/
@PulumiTagMarker
public class PlaceIndexArgsBuilder internal constructor() {
private var dataSource: Output? = null
private var dataSourceConfiguration: Output? = null
private var description: Output? = null
private var indexName: Output? = null
private var pricingPlan: Output? = null
private var tags: Output>? = null
/**
* @param value Specifies the geospatial data provider for the new place index.
* > This field is case-sensitive. Enter the valid values as shown. For example, entering `HERE` returns an error.
* Valid values include:
* - `Esri` – For additional information about [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html) 's coverage in your region of interest, see [Esri details on geocoding coverage](https://docs.aws.amazon.com/https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm) .
* - `Grab` – Grab provides place index functionality for Southeast Asia. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/grab.html) ' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area) .
* - `Here` – For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) ' coverage in your region of interest, see [HERE details on goecoding coverage](https://docs.aws.amazon.com/https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html) .
* > If you specify HERE Technologies ( `Here` ) as the data provider, you may not [store results](https://docs.aws.amazon.com//location-places/latest/APIReference/API_DataSourceConfiguration.html) for locations in Japan. For more information, see the [AWS Service Terms](https://docs.aws.amazon.com/service-terms/) for Amazon Location Service.
* For additional information , see [Data providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) on the *Amazon Location Service Developer Guide* .
*/
@JvmName("jatkitljerxwtbpr")
public suspend fun dataSource(`value`: Output) {
this.dataSource = value
}
/**
* @param value Specifies the data storage option requesting Places.
*/
@JvmName("ahrvsvlflrfyaqpr")
public suspend fun dataSourceConfiguration(`value`: Output) {
this.dataSourceConfiguration = value
}
/**
* @param value The optional description for the place index resource.
*/
@JvmName("wnllhncoaopkmnqd")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The name of the place index resource.
* Requirements:
* - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique place index resource name.
* - No spaces allowed. For example, `ExamplePlaceIndex` .
*/
@JvmName("mdqdpcvnxcuqyktl")
public suspend fun indexName(`value`: Output) {
this.indexName = value
}
/**
* @param value No longer used. If included, the only allowed value is `RequestBasedUsage` .
* *Allowed Values* : `RequestBasedUsage`
*/
@JvmName("hbjnkvauffjnnifc")
public suspend fun pricingPlan(`value`: Output) {
this.pricingPlan = value
}
/**
* @param value An array of key-value pairs to apply to this resource.
*/
@JvmName("dsgxfmadbnulbwpg")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
@JvmName("gcmmyspdjftvpsjv")
public suspend fun tags(vararg values: Output) {
this.tags = Output.all(values.asList())
}
/**
* @param values An array of key-value pairs to apply to this resource.
*/
@JvmName("rrgcbvrrcrsehcyq")
public suspend fun tags(values: List>) {
this.tags = Output.all(values)
}
/**
* @param value Specifies the geospatial data provider for the new place index.
* > This field is case-sensitive. Enter the valid values as shown. For example, entering `HERE` returns an error.
* Valid values include:
* - `Esri` – For additional information about [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html) 's coverage in your region of interest, see [Esri details on geocoding coverage](https://docs.aws.amazon.com/https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm) .
* - `Grab` – Grab provides place index functionality for Southeast Asia. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/grab.html) ' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area) .
* - `Here` – For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) ' coverage in your region of interest, see [HERE details on goecoding coverage](https://docs.aws.amazon.com/https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html) .
* > If you specify HERE Technologies ( `Here` ) as the data provider, you may not [store results](https://docs.aws.amazon.com//location-places/latest/APIReference/API_DataSourceConfiguration.html) for locations in Japan. For more information, see the [AWS Service Terms](https://docs.aws.amazon.com/service-terms/) for Amazon Location Service.
* For additional information , see [Data providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) on the *Amazon Location Service Developer Guide* .
*/
@JvmName("nxqyajtspdbakukw")
public suspend fun dataSource(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataSource = mapped
}
/**
* @param value Specifies the data storage option requesting Places.
*/
@JvmName("tlthkdmpbeuhlfth")
public suspend fun dataSourceConfiguration(`value`: PlaceIndexDataSourceConfigurationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataSourceConfiguration = mapped
}
/**
* @param argument Specifies the data storage option requesting Places.
*/
@JvmName("vvjbfktfdpljcrpy")
public suspend fun dataSourceConfiguration(argument: suspend PlaceIndexDataSourceConfigurationArgsBuilder.() -> Unit) {
val toBeMapped = PlaceIndexDataSourceConfigurationArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.dataSourceConfiguration = mapped
}
/**
* @param value The optional description for the place index resource.
*/
@JvmName("lhdtvthlhqqswuyw")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value The name of the place index resource.
* Requirements:
* - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique place index resource name.
* - No spaces allowed. For example, `ExamplePlaceIndex` .
*/
@JvmName("wwygpdcebwcdqivt")
public suspend fun indexName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.indexName = mapped
}
/**
* @param value No longer used. If included, the only allowed value is `RequestBasedUsage` .
* *Allowed Values* : `RequestBasedUsage`
*/
@JvmName("wwaecvyvwjeajepe")
public suspend fun pricingPlan(`value`: PlaceIndexPricingPlan?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.pricingPlan = mapped
}
/**
* @param value An array of key-value pairs to apply to this resource.
*/
@JvmName("tmfrnxdvfsctekgy")
public suspend fun tags(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param argument An array of key-value pairs to apply to this resource.
*/
@JvmName("njpdstoovtwgvxxf")
public suspend fun tags(argument: List Unit>) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param argument An array of key-value pairs to apply to this resource.
*/
@JvmName("bhxtddvkwhtsccyb")
public suspend fun tags(vararg argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param argument An array of key-value pairs to apply to this resource.
*/
@JvmName("duiinuautudmggmq")
public suspend fun tags(argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = listOf(TagArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param values An array of key-value pairs to apply to this resource.
*/
@JvmName("tkpnektlxyhcxsrn")
public suspend fun tags(vararg values: TagArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
internal fun build(): PlaceIndexArgs = PlaceIndexArgs(
dataSource = dataSource,
dataSourceConfiguration = dataSourceConfiguration,
description = description,
indexName = indexName,
pricingPlan = pricingPlan,
tags = tags,
)
}