Package software.amazon.awscdk.services.apigateway

Class RequestAuthorizerProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.RequestAuthorizerProps.Jsii$Proxy
All Implemented Interfaces:
LambdaAuthorizerProps, RequestAuthorizerProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
RequestAuthorizerProps
@Stability(Stable) @Internal public static final class RequestAuthorizerProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements RequestAuthorizerProps
An implementation for RequestAuthorizerProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(RequestAuthorizerProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the RequestAuthorizerProps.Builder.

  • Method Details

    • getIdentitySources

      public final List<String> getIdentitySources()
      Description copied from interface: RequestAuthorizerProps
      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('Authorizer').

      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.

      Specified by:
      getIdentitySources in interface RequestAuthorizerProps
      See Also:

    • getHandler

      public final IFunction getHandler()
      Description copied from interface: LambdaAuthorizerProps
      The handler for the authorizer lambda function.

      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}.
      Specified by:
      getHandler in interface LambdaAuthorizerProps

    • getAssumeRole

      public final IRole getAssumeRole()
      Description copied from interface: LambdaAuthorizerProps
      An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer.

      The IAM role must be assumable by 'apigateway.amazonaws.com'.

      Default: - A resource policy is added to the Lambda function allowing apigateway.amazonaws.com to invoke the function.

      Specified by:
      getAssumeRole in interface LambdaAuthorizerProps

    • getAuthorizerName

      public final String getAuthorizerName()
      Description copied from interface: LambdaAuthorizerProps
      An optional human friendly name for the authorizer.

      Note that, this is not the primary identifier of the authorizer.

      Default: - the unique construcrt ID

      Specified by:
      getAuthorizerName in interface LambdaAuthorizerProps

    • getResultsCacheTtl

      public final Duration getResultsCacheTtl()
      Description copied from interface: LambdaAuthorizerProps
      How long APIGateway should cache the results.

      Max 1 hour. Disable caching by setting this to 0.

      Default: Duration.minutes(5)

      Specified by:
      getResultsCacheTtl in interface LambdaAuthorizerProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object