Package software.amazon.awscdk.services.apigatewayv2

Interface HttpAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:10.748Z")
@Stability(Stable)
public interface HttpAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

Properties to initialize an instance of HttpAuthorizer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.apigatewayv2.*;
 HttpApi httpApi;
 HttpAuthorizerProps httpAuthorizerProps = HttpAuthorizerProps.builder()
         .httpApi(httpApi)
         .identitySource(List.of("identitySource"))
         .type(HttpAuthorizerType.IAM)
         // the properties below are optional
         .authorizerName("authorizerName")
         .authorizerUri("authorizerUri")
         .enableSimpleResponses(false)
         .jwtAudience(List.of("jwtAudience"))
         .jwtIssuer("jwtIssuer")
         .payloadFormatVersion(AuthorizerPayloadVersion.VERSION_1_0)
         .resultsCacheTtl(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpAuthorizerProps.Builder	builder()
default String	getAuthorizerName()	Name of the authorizer.
default String	getAuthorizerUri()	The authorizer's Uniform Resource Identifier (URI).
default Boolean	getEnableSimpleResponses()	Specifies whether a Lambda authorizer returns a response in a simple format.
IHttpApi	getHttpApi()	HTTP Api to attach the authorizer to.
List<String>	getIdentitySource()	The identity source for which authorization is requested.
default List<String>	getJwtAudience()	A list of the intended recipients of the JWT.
default String	getJwtIssuer()	The base domain of the identity provider that issues JWT.
default AuthorizerPayloadVersion	getPayloadFormatVersion()	Specifies the format of the payload sent to an HTTP API Lambda authorizer.
default Duration	getResultsCacheTtl()	How long APIGateway should cache the results.
HttpAuthorizerType	getType()	The type of authorizer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHttpApi

@Stability(Stable)
@NotNull
IHttpApi getHttpApi()

HTTP Api to attach the authorizer to.

getIdentitySource

@Stability(Stable)
@NotNull
List<String> getIdentitySource()

The identity source for which authorization is requested.

See Also:

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

getType

@Stability(Stable)
@NotNull
HttpAuthorizerType getType()

The type of authorizer.

getAuthorizerName

@Stability(Stable)
@Nullable
default String getAuthorizerName()

Name of the authorizer.

Default: - id of the HttpAuthorizer construct.

getAuthorizerUri

@Stability(Stable)
@Nullable
default String getAuthorizerUri()

The authorizer's Uniform Resource Identifier (URI).

For REQUEST authorizers, this must be a well-formed Lambda function URI.

Default: - required for Request authorizer types

getEnableSimpleResponses

@Stability(Stable)
@Nullable
default Boolean getEnableSimpleResponses()

Specifies whether a Lambda authorizer returns a response in a simple format.

If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy.

Default: - The lambda authorizer must return an IAM policy as its response

getJwtAudience

@Stability(Stable)
@Nullable
default List<String> getJwtAudience()

A list of the intended recipients of the JWT.

A valid JWT must provide an aud that matches at least one entry in this list.

Default: - required for JWT authorizer typess.

getJwtIssuer

@Stability(Stable)
@Nullable
default String getJwtIssuer()

The base domain of the identity provider that issues JWT.

Default: - required for JWT authorizer types.

getPayloadFormatVersion

@Stability(Stable)
@Nullable
default AuthorizerPayloadVersion getPayloadFormatVersion()

Specifies the format of the payload sent to an HTTP API Lambda authorizer.

Default: AuthorizerPayloadVersion.VERSION_2_0 if the authorizer type is HttpAuthorizerType.LAMBDA

getResultsCacheTtl

@Stability(Stable)
@Nullable
default Duration getResultsCacheTtl()

How long APIGateway should cache the results.

Max 1 hour.

Default: - API Gateway will not cache authorizer responses

builder

@Stability(Stable)
static HttpAuthorizerProps.Builder builder()

Returns:

a HttpAuthorizerProps.Builder of HttpAuthorizerProps