Package software.aws.awsprototypingsdk.openapigateway

Interface CustomAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.82.0 (build 2d2ddd7)",
           date="2023-08-09T23:59:30.256Z")
@Stability(Experimental)
public interface CustomAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties used to configure a custom authorizer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomAuthorizerProps.Builder	A builder for CustomAuthorizerProps
static class	CustomAuthorizerProps.Jsii$Proxy	An implementation for CustomAuthorizerProps

Method Summary

Modifier and Type	Method	Description
static CustomAuthorizerProps.Builder	builder()
String	getAuthorizerId()	(experimental) Unique identifier for this authorizer.
default 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.
default String	getIdentitySource()	(experimental) The source of the identity in an incoming request.
default CustomAuthorizerType	getType()	(experimental) The type of custom authorizer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthorizerId

@Stability(Experimental)
@NotNull
String getAuthorizerId()

(experimental) Unique identifier for this authorizer.

getFunction

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

(experimental) The lambda function used to authorize requests.

getAuthorizerResultTtlInSeconds

@Stability(Experimental)
@Nullable
default Number getAuthorizerResultTtlInSeconds()

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

Default: 300

getIdentitySource

@Stability(Experimental)
@Nullable
default String getIdentitySource()

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

Default: "method.request.header.Authorization"

See Also:

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

getType

@Stability(Experimental)
@Nullable
default CustomAuthorizerType getType()

(experimental) The type of custom authorizer.

Default: CustomAuthorizerType.TOKEN

See Also:

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

builder

@Stability(Experimental)
static CustomAuthorizerProps.Builder builder()

Returns:

a CustomAuthorizerProps.Builder of CustomAuthorizerProps