software.amazon.awscdk.services.apigateway

Class LambdaAuthorizerProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.LambdaAuthorizerProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaAuthorizerProps>

Enclosing interface:

LambdaAuthorizerProps

@Stability(value=Experimental)
public static final class LambdaAuthorizerProps.Builder
extends Object
implements software.amazon.jsii.Builder<LambdaAuthorizerProps>

A builder for LambdaAuthorizerProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LambdaAuthorizerProps.Builder	assumeRole(IRole assumeRole) Sets the value of LambdaAuthorizerProps.getAssumeRole()
LambdaAuthorizerProps.Builder	authorizerName(String authorizerName) Sets the value of LambdaAuthorizerProps.getAuthorizerName()
LambdaAuthorizerProps	build() Builds the configured instance.
LambdaAuthorizerProps.Builder	handler(IFunction handler) Sets the value of LambdaAuthorizerProps.getHandler()
LambdaAuthorizerProps.Builder	resultsCacheTtl(Duration resultsCacheTtl) Sets the value of LambdaAuthorizerProps.getResultsCacheTtl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

handler

@Stability(value=Experimental)
public LambdaAuthorizerProps.Builder handler(IFunction handler)

Sets the value of LambdaAuthorizerProps.getHandler()

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 {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.html | here} and output specification {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html | here}.

Returns:

this

assumeRole

@Stability(value=Experimental)
public LambdaAuthorizerProps.Builder assumeRole(IRole assumeRole)

Sets the value of LambdaAuthorizerProps.getAssumeRole()

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(value=Experimental)
public LambdaAuthorizerProps.Builder authorizerName(String authorizerName)

Sets the value of LambdaAuthorizerProps.getAuthorizerName()

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(value=Experimental)
public LambdaAuthorizerProps.Builder resultsCacheTtl(Duration resultsCacheTtl)

Sets the value of LambdaAuthorizerProps.getResultsCacheTtl()

Parameters:

resultsCacheTtl - How long APIGateway should cache the results. Max 1 hour. Disable caching by setting this to 0.

Returns:

this

build

@Stability(value=Experimental)
public LambdaAuthorizerProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<LambdaAuthorizerProps>

Returns:

a new instance of LambdaAuthorizerProps

Throws:

NullPointerException - if any required attribute was not provided