Class RequestAuthorizer

All Implemented Interfaces:
IConstruct, IDependable, IResource, IAuthorizer,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.052Z") @Stability(Stable) public class RequestAuthorizer extends Authorizer implements IAuthorizer
Request-based lambda authorizer that recognizes the caller's identity via request parameters, such as headers, paths, query strings, stage variables, or context variables.

Based on the request, authorization is performed by a lambda function.


 Function authFn;
 Resource books;
 RequestAuthorizer auth = RequestAuthorizer.Builder.create(this, "booksAuthorizer")
 books.addMethod("GET", new HttpIntegration(""), MethodOptions.builder()
  • Constructor Details

    • RequestAuthorizer

      protected RequestAuthorizer( objRef)
    • RequestAuthorizer

      protected RequestAuthorizer( initializationMode)
    • RequestAuthorizer

      @Stability(Stable) public RequestAuthorizer(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull RequestAuthorizerProps props)
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
  • Method Details

    • lazyRestApiId

      @Stability(Stable) @NotNull protected String lazyRestApiId()
      Returns a token that resolves to the Rest Api Id at the time of synthesis.

      Throws an error, during token resolution, if no RestApi is attached to this authorizer.

    • setupPermissions

      @Stability(Stable) protected void setupPermissions()
      Sets up the permissions necessary for the API Gateway service to invoke the Lambda function.
    • getAuthorizerArn

      @Stability(Stable) @NotNull public String getAuthorizerArn()
      The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants.
    • getAuthorizerId

      @Stability(Stable) @NotNull public String getAuthorizerId()
      The id of the authorizer.
      Specified by:
      getAuthorizerId in interface IAuthorizer
      Specified by:
      getAuthorizerId in class Authorizer
    • getHandler

      @Stability(Stable) @NotNull protected IFunction getHandler()
      The Lambda function handler that this authorizer uses.
    • getRole

      @Stability(Stable) @Nullable protected IRole getRole()
      The IAM role that the API Gateway service assumes while invoking the Lambda function.
    • getRestApiId

      @Stability(Stable) @Nullable protected String getRestApiId()
    • setRestApiId

      @Stability(Stable) protected void setRestApiId(@Nullable String value)