software.amazon.awscdk.services.apigateway

Class TokenAuthorizerProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.TokenAuthorizerProps.Jsii$Proxy

All Implemented Interfaces:

LambdaAuthorizerProps, TokenAuthorizerProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

TokenAuthorizerProps

@Stability(value=Stable)
 @Internal
public static final class TokenAuthorizerProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements TokenAuthorizerProps

An implementation for TokenAuthorizerProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.TokenAuthorizerProps

TokenAuthorizerProps.Builder, TokenAuthorizerProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(TokenAuthorizerProps.Builder builder) Constructor that initializes the object based on literal property values passed by the TokenAuthorizerProps.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
IRole	getAssumeRole() An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer.
String	getAuthorizerName() An optional human friendly name for the authorizer.
IFunction	getHandler() The handler for the authorizer lambda function.
String	getIdentitySource() The request header mapping expression for the bearer token.
Duration	getResultsCacheTtl() How long APIGateway should cache the results.
String	getValidationRegex() An optional regex to be matched against the authorization token.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.apigateway.TokenAuthorizerProps

builder

Constructor Detail

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(TokenAuthorizerProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the TokenAuthorizerProps.Builder.

Method Detail

getIdentitySource

public final String getIdentitySource()

Description copied from interface: TokenAuthorizerProps

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.

Default: `IdentitySource.header('Authorization')`

Specified by:

getIdentitySource in interface TokenAuthorizerProps

See Also:

https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource

getValidationRegex

public final String getValidationRegex()

Description copied from interface: TokenAuthorizerProps

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.

Default: - no regex filter will be applied.

Specified by:

getValidationRegex in interface TokenAuthorizerProps

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 {@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}.

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