AuthorizerArgs

data class AuthorizerArgs(val authorizerCredentials: Output<String>? = null, val authorizerResultTtlInSeconds: Output<Int>? = null, val authorizerUri: Output<String>? = null, val identitySource: Output<String>? = null, val identityValidationExpression: Output<String>? = null, val name: Output<String>? = null, val providerArns: Output<List<String>>? = null, val restApi: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<AuthorizerArgs>

Provides an API Gateway Authorizer.

Import

AWS API Gateway Authorizer can be imported using the REST-API-ID/AUTHORIZER-ID, e.g.,

$ pulumi import aws:apigateway/authorizer:Authorizer authorizer 12345abcde/example

Constructors

Link copied to clipboard
constructor(authorizerCredentials: Output<String>? = null, authorizerResultTtlInSeconds: Output<Int>? = null, authorizerUri: Output<String>? = null, identitySource: Output<String>? = null, identityValidationExpression: Output<String>? = null, name: Output<String>? = null, providerArns: Output<List<String>>? = null, restApi: Output<String>? = null, type: Output<String>? = null)

Properties

Link copied to clipboard
val authorizerCredentials: Output<String>? = null

Credentials required for the authorizer. To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.

Link copied to clipboard
val authorizerResultTtlInSeconds: Output<Int>? = null

TTL of cached authorizer results in seconds. Defaults to 300.

Link copied to clipboard
val authorizerUri: Output<String>? = null

Authorizer's Uniform Resource Identifier (URI). This must be a well-formed Lambda function URI in the form of arn:aws:apigateway:{region}:lambda:path/{service_api}, e.g., arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations

Link copied to clipboard
val identitySource: Output<String>? = null

Source of the identity in an incoming request. Defaults to method.request.header.Authorization. For REQUEST type, this may be a comma-separated list of values, including headers, query string parameters and stage variables - e.g., "method.request.header.SomeHeaderName,method.request.querystring.SomeQueryStringName,stageVariables.SomeStageVariableName"

Link copied to clipboard

Validation expression for the incoming identity. For TOKEN type, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

Link copied to clipboard
val name: Output<String>? = null

Name of the authorizer

Link copied to clipboard
val providerArns: Output<List<String>>? = null

List of the Amazon Cognito user pool ARNs. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

Link copied to clipboard
val restApi: Output<String>? = null

ID of the associated REST API

Link copied to clipboard
val type: Output<String>? = null

Type of the authorizer. Possible 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, or COGNITO_USER_POOLS for using an Amazon Cognito user pool. Defaults to TOKEN.

Functions

Link copied to clipboard
open override fun toJava(): AuthorizerArgs