Header menu logo FsCDK

TokenAuthorizerBuilder Type

Constructors

Constructor Description

TokenAuthorizerBuilder(name)

Full Usage: TokenAuthorizerBuilder(name)

Parameters:
    name : string

Returns: TokenAuthorizerBuilder
name : string
Returns: TokenAuthorizerBuilder

Instance members

Instance member Description

assumeRole role

Full Usage: assumeRole role

Parameters:
Returns: TokenAuthorizerConfig

Sets the IAM role for API Gateway to assume when calling the authorizer.

role : IRole
Returns: TokenAuthorizerConfig

this.Combine

Full Usage: this.Combine

Parameters:
Returns: TokenAuthorizerConfig
state1 : TokenAuthorizerConfig
state2 : TokenAuthorizerConfig
Returns: TokenAuthorizerConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string

Returns: TokenAuthorizerConfig

Sets a custom construct ID.

id : string
Returns: TokenAuthorizerConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: TokenAuthorizerConfig
Modifiers: inline
f : unit -> TokenAuthorizerConfig
Returns: TokenAuthorizerConfig

this.For

Full Usage: this.For

Parameters:
Returns: TokenAuthorizerConfig
Modifiers: inline
config : TokenAuthorizerConfig
f : unit -> TokenAuthorizerConfig
Returns: TokenAuthorizerConfig

handler handler

Full Usage: handler handler

Parameters:
Returns: TokenAuthorizerConfig

Sets the Lambda function to use for authorization.

handler : IFunction
Returns: TokenAuthorizerConfig

identitySource source

Full Usage: identitySource source

Parameters:
    source : string

Returns: TokenAuthorizerConfig

Sets the identity source for the authorization token.

source : string
Returns: TokenAuthorizerConfig

resultsCacheTtl ttl

Full Usage: resultsCacheTtl ttl

Parameters:
Returns: TokenAuthorizerConfig

Sets how long API Gateway caches authorizer results.

ttl : Duration
Returns: TokenAuthorizerConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: TokenAuthorizerSpec
config : TokenAuthorizerConfig
Returns: TokenAuthorizerSpec

validationRegex regex

Full Usage: validationRegex regex

Parameters:
    regex : string

Returns: TokenAuthorizerConfig

Sets a validation regex for the authorization token.

regex : string
Returns: TokenAuthorizerConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: TokenAuthorizerConfig
() : unit
Returns: TokenAuthorizerConfig

this.Zero

Full Usage: this.Zero

Returns: TokenAuthorizerConfig
Returns: TokenAuthorizerConfig

Type something to start searching.