Package software.amazon.awscdk.aws_apigatewayv2_authorizers

Class HttpLambdaAuthorizer.Builder

java.lang.Object

software.amazon.awscdk.aws_apigatewayv2_authorizers.HttpLambdaAuthorizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpLambdaAuthorizer>

Enclosing class:

HttpLambdaAuthorizer

@Stability(Stable)
public static final class HttpLambdaAuthorizer.Builder
extends Object
implements software.amazon.jsii.Builder<HttpLambdaAuthorizer>

A fluent builder for HttpLambdaAuthorizer.

Method Summary

Modifier and Type	Method	Description
HttpLambdaAuthorizer.Builder	authorizerName(String authorizerName)	Friendly authorizer name.
HttpLambdaAuthorizer	build()
static HttpLambdaAuthorizer.Builder	create(String id, IFunction handler)
HttpLambdaAuthorizer.Builder	identitySource(List<String> identitySource)	The identity source for which authorization is requested.
HttpLambdaAuthorizer.Builder	responseTypes(List<? extends HttpLambdaResponseType> responseTypes)	The types of responses the lambda can return.
HttpLambdaAuthorizer.Builder	resultsCacheTtl(Duration resultsCacheTtl)	How long APIGateway should cache the results.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static HttpLambdaAuthorizer.Builder create(String id,
 IFunction handler)

Parameters:

id - The id of the underlying construct. This parameter is required.

handler - This parameter is required.

Returns:

a new instance of HttpLambdaAuthorizer.Builder.

authorizerName

@Stability(Stable)
public HttpLambdaAuthorizer.Builder authorizerName(String authorizerName)

Friendly authorizer name.

Default: - same value as `id` passed in the constructor.

Parameters:

authorizerName - Friendly authorizer name. This parameter is required.

Returns:

this

identitySource

@Stability(Stable)
public HttpLambdaAuthorizer.Builder identitySource(List<String> identitySource)

The identity source for which authorization is requested.

Default: ['$request.header.Authorization']

Parameters:

identitySource - The identity source for which authorization is requested. This parameter is required.

Returns:

this

responseTypes

@Stability(Stable)
public HttpLambdaAuthorizer.Builder responseTypes(List<? extends HttpLambdaResponseType> responseTypes)

The types of responses the lambda can return.

If HttpLambdaResponseType.SIMPLE is included then response format 2.0 will be used.

Default: [HttpLambdaResponseType.IAM]

Parameters:

responseTypes - The types of responses the lambda can return. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html#http-api-lambda-authorizer.payload-format-response

resultsCacheTtl

@Stability(Stable)
public HttpLambdaAuthorizer.Builder resultsCacheTtl(Duration resultsCacheTtl)

How long APIGateway should cache the results.

Max 1 hour. Disable caching by setting this to Duration.seconds(0).

Default: Duration.minutes(5)

Parameters:

resultsCacheTtl - How long APIGateway should cache the results. This parameter is required.

Returns:

this

build

@Stability(Stable)
public HttpLambdaAuthorizer build()

Specified by:

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

Returns:

a newly built instance of HttpLambdaAuthorizer.