Package software.amazon.awscdk.services.apigateway

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 Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

identitySource

@Stability(Stable)
public TokenAuthorizerProps.Builder identitySource(String identitySource)

Sets the value of TokenAuthorizerProps.getIdentitySource()

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)

Sets the value of TokenAuthorizerProps.getValidationRegex()

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)

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 and output specification.

Returns:

this

assumeRole

@Stability(Stable)
public TokenAuthorizerProps.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(Stable)
public TokenAuthorizerProps.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(Stable)
public TokenAuthorizerProps.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(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