Package software.amazon.awscdk.services.apigatewayv2

Interface HttpRouteAuthorizerConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpRouteAuthorizerConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:05.987Z")
@Stability(Stable)
public interface HttpRouteAuthorizerConfig
extends software.amazon.jsii.JsiiSerializable

Results of binding an authorizer to an http route.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 HttpRouteAuthorizerConfig httpRouteAuthorizerConfig = HttpRouteAuthorizerConfig.builder()
         .authorizationType("authorizationType")
         // the properties below are optional
         .authorizationScopes(List.of("authorizationScopes"))
         .authorizerId("authorizerId")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpRouteAuthorizerConfig.Builder	builder()
default List<String>	getAuthorizationScopes()	The list of OIDC scopes to include in the authorization.
String	getAuthorizationType()	The type of authorization.
default String	getAuthorizerId()	The authorizer id.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationType

@Stability(Stable)
@NotNull
String getAuthorizationType()

The type of authorization.

Possible values are:

• AWS_IAM - IAM Authorizer
• JWT - JSON Web Token Authorizer
• CUSTOM - Lambda Authorizer
• NONE - No Authorization

getAuthorizationScopes

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

The list of OIDC scopes to include in the authorization.

Default: - no authorization scopes

getAuthorizerId

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

The authorizer id.

Default: - No authorizer id (useful for AWS_IAM route authorizer)

builder

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

Returns:

a HttpRouteAuthorizerConfig.Builder of HttpRouteAuthorizerConfig