software.amazon.awscdk.services.apigatewayv2

Interface AddRoutesOptions

All Superinterfaces:

BatchHttpRouteOptions

All Known Implementing Classes:

AddRoutesOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:23.791Z")
public interface AddRoutesOptions
extends BatchHttpRouteOptions

(experimental) Options for the Route with Integration resource.

Example:

 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpLambdaAuthorizer;
 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpLambdaResponseType;
 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpUrlIntegration;
 // This function handles your auth logic
 Function authHandler;
 HttpLambdaAuthorizer authorizer = HttpLambdaAuthorizer.Builder.create("BooksAuthorizer", authHandler)
         .responseTypes(List.of(HttpLambdaResponseType.SIMPLE))
         .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	AddRoutesOptions.Builder A builder for AddRoutesOptions
static class	AddRoutesOptions.Jsii$Proxy An implementation for AddRoutesOptions

Method Summary

Modifier and Type	Method and Description
static AddRoutesOptions.Builder	builder()
default java.util.List<java.lang.String>	getAuthorizationScopes() (experimental) The list of OIDC scopes to include in the authorization.
default IHttpRouteAuthorizer	getAuthorizer() (experimental) Authorizer to be associated to these routes.
default java.util.List<HttpMethod>	getMethods() (experimental) The HTTP methods to be configured.
java.lang.String	getPath() (experimental) The path at which all of these routes are configured.

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.BatchHttpRouteOptions

getIntegration

Method Detail

getPath

java.lang.String getPath()

(experimental) The path at which all of these routes are configured.

getAuthorizationScopes

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

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

These scopes will override the default authorization scopes on the gateway. Set to [] to remove default scopes

Default: - uses defaultAuthorizationScopes if configured on the API, otherwise none.

getAuthorizer

default IHttpRouteAuthorizer getAuthorizer()

(experimental) Authorizer to be associated to these routes.

Use NoneAuthorizer to remove the default authorizer for the api

Default: - uses the default authorizer if one is specified on the HttpApi

getMethods

default java.util.List<HttpMethod> getMethods()

(experimental) The HTTP methods to be configured.

Default: HttpMethod.ANY

builder

static AddRoutesOptions.Builder builder()

Specified by:

builder in interface BatchHttpRouteOptions

Returns:

a AddRoutesOptions.Builder of AddRoutesOptions