class Aws::ApiGatewayV2::Types::Authorizer

@return [Boolean]<br>: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html<br><br><br><br>more, see [Working with AWS Lambda authorizers for HTTP APIs][1]
instead of an IAM policy. Supported only for HTTP APIs. To learn
format. If enabled, the Lambda authorizer can return a boolean value
Specifies whether a Lambda authorizer returns a response in a simple
@!attribute [rw] enable_simple_responses
@return [String]<br>: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html<br><br><br><br>authorizers for HTTP APIs].
values are 1.0 and 2.0. To learn more, see [Working with AWS Lambda
authorizer. Required for HTTP API Lambda authorizers. Supported
Specifies the format of the payload sent to an HTTP API Lambda
@!attribute [rw] authorizer_payload_format_version
@return [String]
The name of the authorizer.
@!attribute [rw] name
@return [Types::JWTConfiguration]
JWT authorizer type. Supported only for HTTP APIs.
Represents the configuration of a JWT authorizer. Required for the
@!attribute [rw] jwt_configuration
@return [String]
The validation expression does not apply to the REQUEST authorizer.
@!attribute [rw] identity_validation_expression
@return [Array<String>]<br>: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html<br><br><br><br>$request.header.Authorization.
query parameter-based selections are supported, for example
Token (JWT) from inbound requests. Currently only header-based and
For JWT, a single entry that specifies where to extract the JSON Web
[Working with AWS Lambda authorizers for HTTP APIs].
as the cache key when caching is enabled. To learn more, see
the Lambda function. For HTTP APIs, identity sources are also used
Otherwise, it returns a 401 Unauthorized response without calling
true does the authorizer invoke the authorizer Lambda function.
present in the request, not null, and non-empty. Only when this is
by verifying all of the identity-related request parameters are
are used to perform runtime validation for Lambda-based authorizers
$request.header.Auth, $request.querystring.Name. These parameters
use selection expressions prefixed with $, for example,
route.request.querystring.Name for WebSocket APIs. For HTTP APIs,
this value is route.request.header.Auth,
and a Name query string parameter are defined as identity sources,
variables, and context parameters. For example, if an Auth header
The identity source can be headers, query string parameters, stage
one or more mapping expressions of the specified request parameters.
For a REQUEST authorizer, this is optional. The value is a set of
The identity source for which authorization is requested.
@!attribute [rw] identity_source
@return [String]
for REQUEST authorizers.<br>/2015-03-31/functions//invocations. Supported only
Lambda functions, this is usually of the form
treated as the path to the resource, including the initial /. For
path indicates that the remaining substring in the URI should be
\{region\} is the same as the region hosting the Lambda function,
, where <replaceable />
arn:aws:apigateway:*\{region\}:lambda:path/\{service_api\}*
In general, the URI has this form:
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.
example,
authorizers, this must be a well-formed Lambda function URI, for
The authorizer’s Uniform Resource Identifier (URI). For REQUEST
@!attribute [rw] authorizer_uri
@return [String]
(supported only for HTTP APIs).
incoming request parameters. Specify JWT to use JSON Web Tokens
The authorizer type. Specify REQUEST for a Lambda function using
@!attribute [rw] authorizer_type
@return [Integer]
is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
than 0, API Gateway caches authorizer responses. The maximum value
it equals 0, authorization caching is disabled. If it is greater
The time to live (TTL) for cached authorizer results, in seconds. If
@!attribute [rw] authorizer_result_ttl_in_seconds
@return [String]
The authorizer identifier.
@!attribute [rw] authorizer_id
@return [String]
this parameter. Supported only for REQUEST authorizers.
resource-based permissions on the Lambda function, don’t specify
assume, use the role’s Amazon Resource Name (ARN). To use
invoke the authorizer. To specify an IAM role for API Gateway to
Specifies the required credentials as an IAM role for API Gateway to
@!attribute [rw] authorizer_credentials_arn
Represents an authorizer.