com.pulumi.awsnative.apigatewayv2.kotlin.AuthorizerArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.apigatewayv2.kotlin
import com.pulumi.awsnative.apigatewayv2.AuthorizerArgs.builder
import com.pulumi.awsnative.apigatewayv2.kotlin.inputs.AuthorizerJwtConfigurationArgs
import com.pulumi.awsnative.apigatewayv2.kotlin.inputs.AuthorizerJwtConfigurationArgsBuilder
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.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* The ``AWS::ApiGatewayV2::Authorizer`` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*.
* @property apiId The API identifier.
* @property authorizerCredentialsArn Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers.
* @property authorizerPayloadFormatVersion Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are ``1.0`` and ``2.0``. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
* @property authorizerResultTtlInSeconds The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
* @property authorizerType The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs).
* @property authorizerUri The authorizer's Uniform Resource Identifier (URI). For ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form: ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.
* @property enableSimpleResponses Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
* @property identitySource The identity source for which authorization is requested.
* For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
* For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.
* @property identityValidationExpression This parameter is not used.
* @property jwtConfiguration The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.
* @property name The name of the authorizer.
*/
public data class AuthorizerArgs(
public val apiId: Output? = null,
public val authorizerCredentialsArn: Output? = null,
public val authorizerPayloadFormatVersion: Output? = null,
public val authorizerResultTtlInSeconds: Output? = null,
public val authorizerType: Output? = null,
public val authorizerUri: Output? = null,
public val enableSimpleResponses: Output? = null,
public val identitySource: Output>? = null,
public val identityValidationExpression: Output? = null,
public val jwtConfiguration: Output? = null,
public val name: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.apigatewayv2.AuthorizerArgs =
com.pulumi.awsnative.apigatewayv2.AuthorizerArgs.builder()
.apiId(apiId?.applyValue({ args0 -> args0 }))
.authorizerCredentialsArn(authorizerCredentialsArn?.applyValue({ args0 -> args0 }))
.authorizerPayloadFormatVersion(authorizerPayloadFormatVersion?.applyValue({ args0 -> args0 }))
.authorizerResultTtlInSeconds(authorizerResultTtlInSeconds?.applyValue({ args0 -> args0 }))
.authorizerType(authorizerType?.applyValue({ args0 -> args0 }))
.authorizerUri(authorizerUri?.applyValue({ args0 -> args0 }))
.enableSimpleResponses(enableSimpleResponses?.applyValue({ args0 -> args0 }))
.identitySource(identitySource?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.identityValidationExpression(identityValidationExpression?.applyValue({ args0 -> args0 }))
.jwtConfiguration(jwtConfiguration?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.name(name?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [AuthorizerArgs].
*/
@PulumiTagMarker
public class AuthorizerArgsBuilder internal constructor() {
private var apiId: Output? = null
private var authorizerCredentialsArn: Output? = null
private var authorizerPayloadFormatVersion: Output? = null
private var authorizerResultTtlInSeconds: Output? = null
private var authorizerType: Output? = null
private var authorizerUri: Output? = null
private var enableSimpleResponses: Output? = null
private var identitySource: Output>? = null
private var identityValidationExpression: Output? = null
private var jwtConfiguration: Output? = null
private var name: Output? = null
/**
* @param value The API identifier.
*/
@JvmName("fmcborthjsiusncg")
public suspend fun apiId(`value`: Output) {
this.apiId = value
}
/**
* @param value Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers.
*/
@JvmName("gkourcyvbvlafvxl")
public suspend fun authorizerCredentialsArn(`value`: Output) {
this.authorizerCredentialsArn = value
}
/**
* @param value Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are ``1.0`` and ``2.0``. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
*/
@JvmName("uwmrcexxuoyykxyx")
public suspend fun authorizerPayloadFormatVersion(`value`: Output) {
this.authorizerPayloadFormatVersion = value
}
/**
* @param value The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
*/
@JvmName("wpllrshpojlxncfa")
public suspend fun authorizerResultTtlInSeconds(`value`: Output) {
this.authorizerResultTtlInSeconds = value
}
/**
* @param value The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs).
*/
@JvmName("yduonlwykqvllueo")
public suspend fun authorizerType(`value`: Output) {
this.authorizerType = value
}
/**
* @param value The authorizer's Uniform Resource Identifier (URI). For ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form: ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.
*/
@JvmName("ffeafbhxklsftmcr")
public suspend fun authorizerUri(`value`: Output) {
this.authorizerUri = value
}
/**
* @param value Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
*/
@JvmName("myirkmdserwsqesp")
public suspend fun enableSimpleResponses(`value`: Output) {
this.enableSimpleResponses = value
}
/**
* @param value The identity source for which authorization is requested.
* For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
* For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.
*/
@JvmName("drveuklrsfpakljh")
public suspend fun identitySource(`value`: Output>) {
this.identitySource = value
}
@JvmName("hpisybcfdhndeabw")
public suspend fun identitySource(vararg values: Output) {
this.identitySource = Output.all(values.asList())
}
/**
* @param values The identity source for which authorization is requested.
* For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
* For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.
*/
@JvmName("gddeldepivmrcrdb")
public suspend fun identitySource(values: List>) {
this.identitySource = Output.all(values)
}
/**
* @param value This parameter is not used.
*/
@JvmName("hkblbpjoycgaxaqn")
public suspend fun identityValidationExpression(`value`: Output) {
this.identityValidationExpression = value
}
/**
* @param value The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.
*/
@JvmName("jrjibvketovjwamb")
public suspend fun jwtConfiguration(`value`: Output) {
this.jwtConfiguration = value
}
/**
* @param value The name of the authorizer.
*/
@JvmName("bdatkjneygkecfsk")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The API identifier.
*/
@JvmName("vhddpqtnqqmhuyvf")
public suspend fun apiId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.apiId = mapped
}
/**
* @param value Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers.
*/
@JvmName("jlvmycsjlvbjabot")
public suspend fun authorizerCredentialsArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authorizerCredentialsArn = mapped
}
/**
* @param value Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are ``1.0`` and ``2.0``. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
*/
@JvmName("tvtrecydhkkknmfl")
public suspend fun authorizerPayloadFormatVersion(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authorizerPayloadFormatVersion = mapped
}
/**
* @param value The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
*/
@JvmName("uftnbxanmobdtard")
public suspend fun authorizerResultTtlInSeconds(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authorizerResultTtlInSeconds = mapped
}
/**
* @param value The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs).
*/
@JvmName("cgjeyqyedtricfjo")
public suspend fun authorizerType(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authorizerType = mapped
}
/**
* @param value The authorizer's Uniform Resource Identifier (URI). For ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form: ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.
*/
@JvmName("jmhlpmsfmumsomce")
public suspend fun authorizerUri(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authorizerUri = mapped
}
/**
* @param value Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
*/
@JvmName("rfyjwmnveotcqcle")
public suspend fun enableSimpleResponses(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enableSimpleResponses = mapped
}
/**
* @param value The identity source for which authorization is requested.
* For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
* For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.
*/
@JvmName("ofntvskfecedfduq")
public suspend fun identitySource(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.identitySource = mapped
}
/**
* @param values The identity source for which authorization is requested.
* For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
* For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.
*/
@JvmName("reicdmhsylpifnop")
public suspend fun identitySource(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.identitySource = mapped
}
/**
* @param value This parameter is not used.
*/
@JvmName("wwakorsiubogibyj")
public suspend fun identityValidationExpression(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.identityValidationExpression = mapped
}
/**
* @param value The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.
*/
@JvmName("cdjpcskxxivptndt")
public suspend fun jwtConfiguration(`value`: AuthorizerJwtConfigurationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.jwtConfiguration = mapped
}
/**
* @param argument The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.
*/
@JvmName("vfckyvwijrtfqiwb")
public suspend fun jwtConfiguration(argument: suspend AuthorizerJwtConfigurationArgsBuilder.() -> Unit) {
val toBeMapped = AuthorizerJwtConfigurationArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.jwtConfiguration = mapped
}
/**
* @param value The name of the authorizer.
*/
@JvmName("mrjnwkiakxbkcmnv")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
internal fun build(): AuthorizerArgs = AuthorizerArgs(
apiId = apiId,
authorizerCredentialsArn = authorizerCredentialsArn,
authorizerPayloadFormatVersion = authorizerPayloadFormatVersion,
authorizerResultTtlInSeconds = authorizerResultTtlInSeconds,
authorizerType = authorizerType,
authorizerUri = authorizerUri,
enableSimpleResponses = enableSimpleResponses,
identitySource = identitySource,
identityValidationExpression = identityValidationExpression,
jwtConfiguration = jwtConfiguration,
name = name,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy