com.pulumi.awsnative.location.kotlin.inputs.ApiKeyRestrictionsArgs.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.inputs
import com.pulumi.awsnative.location.inputs.ApiKeyRestrictionsArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
*
* @property allowActions A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
* The following are valid values for the actions.
* - *Map actions*
* - `geo:GetMap*` - Allows all actions needed for map rendering.
* - *Place actions*
* - `geo:SearchPlaceIndexForText` - Allows geocoding.
* - `geo:SearchPlaceIndexForPosition` - Allows reverse geocoding.
* - `geo:SearchPlaceIndexForSuggestions` - Allows generating suggestions from text.
* - `geo:GetPlace` - Allows finding a place by place ID.
* - *Route actions*
* - `geo:CalculateRoute` - Allows point to point routing.
* - `geo:CalculateRouteMatrix` - Allows calculating a matrix of routes.
* > You must use these strings exactly. For example, to provide access to map rendering, the only valid action is `geo:GetMap*` as an input to the list. `["geo:GetMap*"]` is valid but `["geo:GetMapTile"]` is not. Similarly, you cannot use `["geo:SearchPlaceIndexFor*"]` - you must list each of the Place actions separately.
* @property allowReferers An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
* Requirements:
* - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list `$\-._+!*`(),;/?:@=&`
* - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
* - May contain wildcard characters question mark (?) and asterisk (*).
* Question mark (?) will replace any single character (including hexadecimal digits).
* Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
* - No spaces allowed. For example, `https://example.com` .
* @property allowResources A list of allowed resource ARNs that a API key bearer can perform actions on.
* - The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
* - The resources must be in the same `partition` , `region` , and `account-id` as the key that is being created.
* - Other than wildcards, you must include the full ARN, including the `arn` , `partition` , `service` , `region` , `account-id` and `resource-id` delimited by colons (:).
* - No spaces allowed, even with wildcards. For example, `arn:aws:geo:region: *account-id* :map/ExampleMap*` .
* For more information about ARN format, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) .
*/
public data class ApiKeyRestrictionsArgs(
public val allowActions: Output>,
public val allowReferers: Output>? = null,
public val allowResources: Output>,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.location.inputs.ApiKeyRestrictionsArgs =
com.pulumi.awsnative.location.inputs.ApiKeyRestrictionsArgs.builder()
.allowActions(allowActions.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.allowReferers(allowReferers?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.allowResources(allowResources.applyValue({ args0 -> args0.map({ args0 -> args0 }) })).build()
}
/**
* Builder for [ApiKeyRestrictionsArgs].
*/
@PulumiTagMarker
public class ApiKeyRestrictionsArgsBuilder internal constructor() {
private var allowActions: Output>? = null
private var allowReferers: Output>? = null
private var allowResources: Output>? = null
/**
* @param value A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
* The following are valid values for the actions.
* - *Map actions*
* - `geo:GetMap*` - Allows all actions needed for map rendering.
* - *Place actions*
* - `geo:SearchPlaceIndexForText` - Allows geocoding.
* - `geo:SearchPlaceIndexForPosition` - Allows reverse geocoding.
* - `geo:SearchPlaceIndexForSuggestions` - Allows generating suggestions from text.
* - `geo:GetPlace` - Allows finding a place by place ID.
* - *Route actions*
* - `geo:CalculateRoute` - Allows point to point routing.
* - `geo:CalculateRouteMatrix` - Allows calculating a matrix of routes.
* > You must use these strings exactly. For example, to provide access to map rendering, the only valid action is `geo:GetMap*` as an input to the list. `["geo:GetMap*"]` is valid but `["geo:GetMapTile"]` is not. Similarly, you cannot use `["geo:SearchPlaceIndexFor*"]` - you must list each of the Place actions separately.
*/
@JvmName("dggbbtwcubhpxxdl")
public suspend fun allowActions(`value`: Output>) {
this.allowActions = value
}
@JvmName("iebaercklrpgudky")
public suspend fun allowActions(vararg values: Output) {
this.allowActions = Output.all(values.asList())
}
/**
* @param values A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
* The following are valid values for the actions.
* - *Map actions*
* - `geo:GetMap*` - Allows all actions needed for map rendering.
* - *Place actions*
* - `geo:SearchPlaceIndexForText` - Allows geocoding.
* - `geo:SearchPlaceIndexForPosition` - Allows reverse geocoding.
* - `geo:SearchPlaceIndexForSuggestions` - Allows generating suggestions from text.
* - `geo:GetPlace` - Allows finding a place by place ID.
* - *Route actions*
* - `geo:CalculateRoute` - Allows point to point routing.
* - `geo:CalculateRouteMatrix` - Allows calculating a matrix of routes.
* > You must use these strings exactly. For example, to provide access to map rendering, the only valid action is `geo:GetMap*` as an input to the list. `["geo:GetMap*"]` is valid but `["geo:GetMapTile"]` is not. Similarly, you cannot use `["geo:SearchPlaceIndexFor*"]` - you must list each of the Place actions separately.
*/
@JvmName("uydiphahercnhkua")
public suspend fun allowActions(values: List>) {
this.allowActions = Output.all(values)
}
/**
* @param value An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
* Requirements:
* - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list `$\-._+!*`(),;/?:@=&`
* - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
* - May contain wildcard characters question mark (?) and asterisk (*).
* Question mark (?) will replace any single character (including hexadecimal digits).
* Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
* - No spaces allowed. For example, `https://example.com` .
*/
@JvmName("cvlfjtywmyxyeenm")
public suspend fun allowReferers(`value`: Output>) {
this.allowReferers = value
}
@JvmName("imckqnsdyytgqixm")
public suspend fun allowReferers(vararg values: Output) {
this.allowReferers = Output.all(values.asList())
}
/**
* @param values An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
* Requirements:
* - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list `$\-._+!*`(),;/?:@=&`
* - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
* - May contain wildcard characters question mark (?) and asterisk (*).
* Question mark (?) will replace any single character (including hexadecimal digits).
* Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
* - No spaces allowed. For example, `https://example.com` .
*/
@JvmName("wmarlpvqkbkymbso")
public suspend fun allowReferers(values: List>) {
this.allowReferers = Output.all(values)
}
/**
* @param value A list of allowed resource ARNs that a API key bearer can perform actions on.
* - The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
* - The resources must be in the same `partition` , `region` , and `account-id` as the key that is being created.
* - Other than wildcards, you must include the full ARN, including the `arn` , `partition` , `service` , `region` , `account-id` and `resource-id` delimited by colons (:).
* - No spaces allowed, even with wildcards. For example, `arn:aws:geo:region: *account-id* :map/ExampleMap*` .
* For more information about ARN format, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) .
*/
@JvmName("kdeddnlrnpidtcgw")
public suspend fun allowResources(`value`: Output>) {
this.allowResources = value
}
@JvmName("nnyltwphdcmhvplv")
public suspend fun allowResources(vararg values: Output) {
this.allowResources = Output.all(values.asList())
}
/**
* @param values A list of allowed resource ARNs that a API key bearer can perform actions on.
* - The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
* - The resources must be in the same `partition` , `region` , and `account-id` as the key that is being created.
* - Other than wildcards, you must include the full ARN, including the `arn` , `partition` , `service` , `region` , `account-id` and `resource-id` delimited by colons (:).
* - No spaces allowed, even with wildcards. For example, `arn:aws:geo:region: *account-id* :map/ExampleMap*` .
* For more information about ARN format, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) .
*/
@JvmName("uuppjpvyyuxafvaf")
public suspend fun allowResources(values: List>) {
this.allowResources = Output.all(values)
}
/**
* @param value A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
* The following are valid values for the actions.
* - *Map actions*
* - `geo:GetMap*` - Allows all actions needed for map rendering.
* - *Place actions*
* - `geo:SearchPlaceIndexForText` - Allows geocoding.
* - `geo:SearchPlaceIndexForPosition` - Allows reverse geocoding.
* - `geo:SearchPlaceIndexForSuggestions` - Allows generating suggestions from text.
* - `geo:GetPlace` - Allows finding a place by place ID.
* - *Route actions*
* - `geo:CalculateRoute` - Allows point to point routing.
* - `geo:CalculateRouteMatrix` - Allows calculating a matrix of routes.
* > You must use these strings exactly. For example, to provide access to map rendering, the only valid action is `geo:GetMap*` as an input to the list. `["geo:GetMap*"]` is valid but `["geo:GetMapTile"]` is not. Similarly, you cannot use `["geo:SearchPlaceIndexFor*"]` - you must list each of the Place actions separately.
*/
@JvmName("dqvysoyminbiqaow")
public suspend fun allowActions(`value`: List) {
val toBeMapped = value
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.allowActions = mapped
}
/**
* @param values A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
* The following are valid values for the actions.
* - *Map actions*
* - `geo:GetMap*` - Allows all actions needed for map rendering.
* - *Place actions*
* - `geo:SearchPlaceIndexForText` - Allows geocoding.
* - `geo:SearchPlaceIndexForPosition` - Allows reverse geocoding.
* - `geo:SearchPlaceIndexForSuggestions` - Allows generating suggestions from text.
* - `geo:GetPlace` - Allows finding a place by place ID.
* - *Route actions*
* - `geo:CalculateRoute` - Allows point to point routing.
* - `geo:CalculateRouteMatrix` - Allows calculating a matrix of routes.
* > You must use these strings exactly. For example, to provide access to map rendering, the only valid action is `geo:GetMap*` as an input to the list. `["geo:GetMap*"]` is valid but `["geo:GetMapTile"]` is not. Similarly, you cannot use `["geo:SearchPlaceIndexFor*"]` - you must list each of the Place actions separately.
*/
@JvmName("elcycvloimnqcsaf")
public suspend fun allowActions(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.allowActions = mapped
}
/**
* @param value An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
* Requirements:
* - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list `$\-._+!*`(),;/?:@=&`
* - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
* - May contain wildcard characters question mark (?) and asterisk (*).
* Question mark (?) will replace any single character (including hexadecimal digits).
* Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
* - No spaces allowed. For example, `https://example.com` .
*/
@JvmName("tpjoogfrtdhbrsbc")
public suspend fun allowReferers(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.allowReferers = mapped
}
/**
* @param values An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
* Requirements:
* - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list `$\-._+!*`(),;/?:@=&`
* - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
* - May contain wildcard characters question mark (?) and asterisk (*).
* Question mark (?) will replace any single character (including hexadecimal digits).
* Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
* - No spaces allowed. For example, `https://example.com` .
*/
@JvmName("kgahqbyrkncynded")
public suspend fun allowReferers(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.allowReferers = mapped
}
/**
* @param value A list of allowed resource ARNs that a API key bearer can perform actions on.
* - The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
* - The resources must be in the same `partition` , `region` , and `account-id` as the key that is being created.
* - Other than wildcards, you must include the full ARN, including the `arn` , `partition` , `service` , `region` , `account-id` and `resource-id` delimited by colons (:).
* - No spaces allowed, even with wildcards. For example, `arn:aws:geo:region: *account-id* :map/ExampleMap*` .
* For more information about ARN format, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) .
*/
@JvmName("wrvpktmgigftdhuu")
public suspend fun allowResources(`value`: List) {
val toBeMapped = value
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.allowResources = mapped
}
/**
* @param values A list of allowed resource ARNs that a API key bearer can perform actions on.
* - The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
* - The resources must be in the same `partition` , `region` , and `account-id` as the key that is being created.
* - Other than wildcards, you must include the full ARN, including the `arn` , `partition` , `service` , `region` , `account-id` and `resource-id` delimited by colons (:).
* - No spaces allowed, even with wildcards. For example, `arn:aws:geo:region: *account-id* :map/ExampleMap*` .
* For more information about ARN format, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) .
*/
@JvmName("fcvlfwbjhjhowdmw")
public suspend fun allowResources(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.allowResources = mapped
}
internal fun build(): ApiKeyRestrictionsArgs = ApiKeyRestrictionsArgs(
allowActions = allowActions ?: throw PulumiNullFieldException("allowActions"),
allowReferers = allowReferers,
allowResources = allowResources ?: throw PulumiNullFieldException("allowResources"),
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy