software.amazon.awscdk.services.apigatewayv2

Interface HttpRouteAuthorizerConfig

All Known Implementing Classes:

HttpRouteAuthorizerConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:56.702Z")
public interface HttpRouteAuthorizerConfig

(experimental) 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 and Description
static class	HttpRouteAuthorizerConfig.Builder A builder for HttpRouteAuthorizerConfig
static class	HttpRouteAuthorizerConfig.Jsii$Proxy An implementation for HttpRouteAuthorizerConfig

Method Summary

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

Method Detail

getAuthorizationType

java.lang.String getAuthorizationType()

(experimental) The type of authorization.

Possible values are:

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

getAuthorizationScopes

default java.util.List<java.lang.String> getAuthorizationScopes()

(experimental) The list of OIDC scopes to include in the authorization.

Default: - no authorization scopes

getAuthorizerId

default java.lang.String getAuthorizerId()

(experimental) The authorizer id.

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

builder

static HttpRouteAuthorizerConfig.Builder builder()

Returns:

a HttpRouteAuthorizerConfig.Builder of HttpRouteAuthorizerConfig