Package software.aws.awsprototypingsdk.openapigateway

Class CustomAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.aws.awsprototypingsdk.openapigateway.Authorizer

software.aws.awsprototypingsdk.openapigateway.CustomAuthorizer

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.69.0 (build f656c31)",
           date="2022-11-14T02:01:28.300Z")
@Stability(Experimental)
public class CustomAuthorizer
extends Authorizer

(experimental) An authorizer that uses a lambda function to authorize requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomAuthorizer.Builder	(experimental) A fluent builder for CustomAuthorizer.

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CustomAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
	CustomAuthorizer(CustomAuthorizerProps props)

Method Summary

Modifier and Type	Method	Description
Number	getAuthorizerResultTtlInSeconds()	(experimental) The number of seconds during which the authorizer result is cached.
software.amazon.awscdk.services.lambda.IFunction	getFunction()	(experimental) The lambda function used to authorize requests.
String	getIdentitySource()	(experimental) The source of the identity in an incoming request.
CustomAuthorizerType	getType()	(experimental) The type of custom authorizer.

Methods inherited from class software.aws.awsprototypingsdk.openapigateway.Authorizer

getAuthorizationScopes, getAuthorizationType, getAuthorizerId

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CustomAuthorizer

protected CustomAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

CustomAuthorizer

protected CustomAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CustomAuthorizer

@Stability(Experimental)
public CustomAuthorizer(@NotNull
                        CustomAuthorizerProps props)

Parameters:

props - This parameter is required.

Method Detail

getAuthorizerResultTtlInSeconds

@Stability(Experimental)
@NotNull
public Number getAuthorizerResultTtlInSeconds()

(experimental) The number of seconds during which the authorizer result is cached.

getFunction

@Stability(Experimental)
@NotNull
public software.amazon.awscdk.services.lambda.IFunction getFunction()

(experimental) The lambda function used to authorize requests.

getIdentitySource

@Stability(Experimental)
@NotNull
public String getIdentitySource()

(experimental) The source of the identity in an incoming request.

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource

getType

@Stability(Experimental)
@NotNull
public CustomAuthorizerType getType()

(experimental) The type of custom authorizer.

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type