com.pulumi.awsnative.apigateway.kotlin.AuthorizerArgs.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.apigateway.kotlin
import com.pulumi.awsnative.apigateway.AuthorizerArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* The ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
* @property authType Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
* @property authorizerCredentials 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.
* @property authorizerResultTtlInSeconds The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
* @property authorizerUri Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``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 identitySource The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
* @property identityValidationExpression A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.
* @property name The name of the authorizer.
* @property providerArns A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
* @property restApiId The string identifier of the associated RestApi.
* @property type The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool.
*/
public data class AuthorizerArgs(
public val authType: Output? = null,
public val authorizerCredentials: Output? = null,
public val authorizerResultTtlInSeconds: Output? = null,
public val authorizerUri: Output? = null,
public val identitySource: Output? = null,
public val identityValidationExpression: Output? = null,
public val name: Output? = null,
public val providerArns: Output>? = null,
public val restApiId: Output? = null,
public val type: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.apigateway.AuthorizerArgs =
com.pulumi.awsnative.apigateway.AuthorizerArgs.builder()
.authType(authType?.applyValue({ args0 -> args0 }))
.authorizerCredentials(authorizerCredentials?.applyValue({ args0 -> args0 }))
.authorizerResultTtlInSeconds(authorizerResultTtlInSeconds?.applyValue({ args0 -> args0 }))
.authorizerUri(authorizerUri?.applyValue({ args0 -> args0 }))
.identitySource(identitySource?.applyValue({ args0 -> args0 }))
.identityValidationExpression(identityValidationExpression?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.providerArns(providerArns?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.restApiId(restApiId?.applyValue({ args0 -> args0 }))
.type(type?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [AuthorizerArgs].
*/
@PulumiTagMarker
public class AuthorizerArgsBuilder internal constructor() {
private var authType: Output? = null
private var authorizerCredentials: Output? = null
private var authorizerResultTtlInSeconds: Output? = null
private var authorizerUri: Output? = null
private var identitySource: Output? = null
private var identityValidationExpression: Output? = null
private var name: Output? = null
private var providerArns: Output>? = null
private var restApiId: Output? = null
private var type: Output? = null
/**
* @param value Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
*/
@JvmName("avkkoqhgbqomuvov")
public suspend fun authType(`value`: Output) {
this.authType = 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.
*/
@JvmName("nnkwswhqrqnuwdik")
public suspend fun authorizerCredentials(`value`: Output) {
this.authorizerCredentials = value
}
/**
* @param value The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
*/
@JvmName("nlmmxvggfvsidscr")
public suspend fun authorizerResultTtlInSeconds(`value`: Output) {
this.authorizerResultTtlInSeconds = value
}
/**
* @param value Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``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("fvxwoxbuyvhplvru")
public suspend fun authorizerUri(`value`: Output) {
this.authorizerUri = value
}
/**
* @param value The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
*/
@JvmName("sqeuuspimgpblydk")
public suspend fun identitySource(`value`: Output) {
this.identitySource = value
}
/**
* @param value A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.
*/
@JvmName("qlsqtyxhdcmcalrg")
public suspend fun identityValidationExpression(`value`: Output) {
this.identityValidationExpression = value
}
/**
* @param value The name of the authorizer.
*/
@JvmName("novfitvratsvjchr")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
*/
@JvmName("ihsrtqhxcpyfanxh")
public suspend fun providerArns(`value`: Output>) {
this.providerArns = value
}
@JvmName("mlotofsknfjdgdbt")
public suspend fun providerArns(vararg values: Output) {
this.providerArns = Output.all(values.asList())
}
/**
* @param values A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
*/
@JvmName("ylriixlmppgfeosb")
public suspend fun providerArns(values: List>) {
this.providerArns = Output.all(values)
}
/**
* @param value The string identifier of the associated RestApi.
*/
@JvmName("tgeqhehweflwgufw")
public suspend fun restApiId(`value`: Output) {
this.restApiId = value
}
/**
* @param value The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool.
*/
@JvmName("yaxocnbrltirbbfe")
public suspend fun type(`value`: Output) {
this.type = value
}
/**
* @param value Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
*/
@JvmName("epbrysqthmaoenvv")
public suspend fun authType(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authType = 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.
*/
@JvmName("qbpdxxxcxkkekomf")
public suspend fun authorizerCredentials(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authorizerCredentials = mapped
}
/**
* @param value The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
*/
@JvmName("slfggacagneydoge")
public suspend fun authorizerResultTtlInSeconds(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authorizerResultTtlInSeconds = mapped
}
/**
* @param value Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``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("lweyuefqeoqjxnqx")
public suspend fun authorizerUri(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authorizerUri = mapped
}
/**
* @param value The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
*/
@JvmName("pmvpwhikgfshcvax")
public suspend fun identitySource(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.identitySource = mapped
}
/**
* @param value A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.
*/
@JvmName("ypxtwsevjjpblqty")
public suspend fun identityValidationExpression(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.identityValidationExpression = mapped
}
/**
* @param value The name of the authorizer.
*/
@JvmName("kpsfycahggomcifl")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
*/
@JvmName("xmggqdtailahxcox")
public suspend fun providerArns(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.providerArns = mapped
}
/**
* @param values A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
*/
@JvmName("kbbvkcjhmsvewdke")
public suspend fun providerArns(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.providerArns = mapped
}
/**
* @param value The string identifier of the associated RestApi.
*/
@JvmName("umpcigyoxfswcafv")
public suspend fun restApiId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.restApiId = mapped
}
/**
* @param value The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool.
*/
@JvmName("efhteciteebjatus")
public suspend fun type(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.type = mapped
}
internal fun build(): AuthorizerArgs = AuthorizerArgs(
authType = authType,
authorizerCredentials = authorizerCredentials,
authorizerResultTtlInSeconds = authorizerResultTtlInSeconds,
authorizerUri = authorizerUri,
identitySource = identitySource,
identityValidationExpression = identityValidationExpression,
name = name,
providerArns = providerArns,
restApiId = restApiId,
type = type,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy