software.amazon.awscdk.services.apigatewayv2.authorizers

Interface HttpJwtAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpJwtAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:23.704Z")
 @Stability(value=Experimental)
public interface HttpJwtAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties to initialize HttpJwtAuthorizer.

Example:

 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpJwtAuthorizer;
 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpUrlIntegration;
 String issuer = "https://test.us.auth0.com";
 HttpJwtAuthorizer authorizer = HttpJwtAuthorizer.Builder.create("BooksAuthorizer", issuer)
         .jwtAudience(List.of("3131231"))
         .build();
 HttpApi api = new HttpApi(this, "HttpApi");
 api.addRoutes(AddRoutesOptions.builder()
         .integration(new HttpUrlIntegration("BooksIntegration", "https://get-books-proxy.myproxy.internal"))
         .path("/books")
         .authorizer(authorizer)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static HttpJwtAuthorizerProps.Builder	builder()
default String	getAuthorizerName() (experimental) The name of the authorizer.
default List<String>	getIdentitySource() (experimental) The identity source for which authorization is requested.
List<String>	getJwtAudience() (experimental) A list of the intended recipients of the JWT.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getJwtAudience

@Stability(value=Experimental)
 @NotNull
List<String> getJwtAudience()

(experimental) 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.

getAuthorizerName

@Stability(value=Experimental)
 @Nullable
default String getAuthorizerName()

(experimental) The name of the authorizer.

Default: - same value as `id` passed in the constructor

getIdentitySource

@Stability(value=Experimental)
 @Nullable
default List<String> getIdentitySource()

(experimental) The identity source for which authorization is requested.

Default: ['$request.header.Authorization']

builder

@Stability(value=Experimental)
static HttpJwtAuthorizerProps.Builder builder()

Returns:

a HttpJwtAuthorizerProps.Builder of HttpJwtAuthorizerProps