Package software.amazon.awscdk.services.apigateway

Interface RequestAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, LambdaAuthorizerProps

All Known Implementing Classes:

RequestAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:23.052Z")
@Stability(Stable)
public interface RequestAuthorizerProps
extends software.amazon.jsii.JsiiSerializable, LambdaAuthorizerProps

Properties for RequestAuthorizer.

Example:

 Function authFn;
 Resource books;
 RequestAuthorizer auth = RequestAuthorizer.Builder.create(this, "booksAuthorizer")
         .handler(authFn)
         .identitySources(List.of(IdentitySource.header("Authorization")))
         .build();
 books.addMethod("GET", new HttpIntegration("http://amazon.com"), MethodOptions.builder()
         .authorizer(auth)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RequestAuthorizerProps.Builder	A builder for RequestAuthorizerProps
static final class	RequestAuthorizerProps.Jsii$Proxy	An implementation for RequestAuthorizerProps

Method Summary

Modifier and Type	Method	Description
static RequestAuthorizerProps.Builder	builder()
List<String>	getIdentitySources()	An array of request header mapping expressions for identities.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.apigateway.LambdaAuthorizerProps

getAssumeRole, getAuthorizerName, getHandler, getResultsCacheTtl

Method Details

getIdentitySources

@Stability(Stable)
@NotNull
List<String> getIdentitySources()

An array of request header mapping expressions for identities.

Supported parameter types are Header, Query String, Stage Variable, and Context. For instance, extracting an authorization token from a header would use the identity source IdentitySource.header('Authorization').

Note: API Gateway uses the specified identity sources as the request authorizer caching key. When caching is enabled, API Gateway calls the authorizer's Lambda function only after successfully verifying that all the specified identity sources are present at runtime. If a specified identify source is missing, null, or empty, API Gateway returns a 401 Unauthorized response without calling the authorizer Lambda function.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/api/API_CreateAuthorizer.html#apigw-CreateAuthorizer-request-identitySource

builder

@Stability(Stable)
static RequestAuthorizerProps.Builder builder()

Returns:

a RequestAuthorizerProps.Builder of RequestAuthorizerProps