Class TokenAuthorizerProps.Builder

java.lang.Object
software.amazon.awscdk.services.apigateway.TokenAuthorizerProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<TokenAuthorizerProps>
Enclosing interface:
TokenAuthorizerProps

@Stability(Stable) public static final class TokenAuthorizerProps.Builder extends Object implements software.amazon.jsii.Builder<TokenAuthorizerProps>
A builder for TokenAuthorizerProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • identitySource

      @Stability(Stable) public TokenAuthorizerProps.Builder identitySource(String identitySource)
      Parameters:
      identitySource - The request header mapping expression for the bearer token. This is typically passed as part of the header, in which case this should be method.request.header.Authorizer where Authorizer is the header containing the bearer token.
      Returns:
      this
    • validationRegex

      @Stability(Stable) public TokenAuthorizerProps.Builder validationRegex(String validationRegex)
      Parameters:
      validationRegex - An optional regex to be matched against the authorization token. When matched the authorizer lambda is invoked, otherwise a 401 Unauthorized is returned to the client.
      Returns:
      this
    • handler

      @Stability(Stable) public TokenAuthorizerProps.Builder handler(IFunction handler)
      Parameters:
      handler - The handler for the authorizer lambda function. This parameter is required. The handler must follow a very specific protocol on the input it receives and the output it needs to produce. API Gateway has documented the handler's input specification
      invalid @link
      {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.html
      | here} and output specification
      invalid @link
      {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html
      | here}.
      Returns:
      this
    • assumeRole

      @Stability(Stable) public TokenAuthorizerProps.Builder assumeRole(IRole assumeRole)
      Parameters:
      assumeRole - An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer. The IAM role must be assumable by 'apigateway.amazonaws.com'.
      Returns:
      this
    • authorizerName

      @Stability(Stable) public TokenAuthorizerProps.Builder authorizerName(String authorizerName)
      Parameters:
      authorizerName - An optional human friendly name for the authorizer. Note that, this is not the primary identifier of the authorizer.
      Returns:
      this
    • resultsCacheTtl

      @Stability(Stable) public TokenAuthorizerProps.Builder resultsCacheTtl(Duration resultsCacheTtl)
      Parameters:
      resultsCacheTtl - How long APIGateway should cache the results. Max 1 hour. Disable caching by setting this to 0.
      Returns:
      this
    • build

      @Stability(Stable) public TokenAuthorizerProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<TokenAuthorizerProps>
      Returns:
      a new instance of TokenAuthorizerProps
      Throws:
      NullPointerException - if any required attribute was not provided