software.amazon.awscdk.services.apigatewayv2

Class HttpRoute.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpRoute.Builder

Enclosing class:

HttpRoute

public static final class HttpRoute.Builder
extends java.lang.Object

(experimental) A fluent builder for HttpRoute.

Method Summary

Modifier and Type	Method and Description
HttpRoute.Builder	authorizationScopes(java.util.List<java.lang.String> authorizationScopes) (experimental) The list of OIDC scopes to include in the authorization.
HttpRoute.Builder	authorizer(IHttpRouteAuthorizer authorizer) (experimental) Authorizer for a WebSocket API or an HTTP API.
HttpRoute	build()
static HttpRoute.Builder	create(software.constructs.Construct scope, java.lang.String id)
HttpRoute.Builder	httpApi(IHttpApi httpApi) (experimental) the API the route is associated with.
HttpRoute.Builder	integration(HttpRouteIntegration integration) (experimental) The integration to be configured on this route.
HttpRoute.Builder	routeKey(HttpRouteKey routeKey) (experimental) The key to this route.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static HttpRoute.Builder create(software.constructs.Construct scope,
                                       java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of HttpRoute.Builder.

integration

public HttpRoute.Builder integration(HttpRouteIntegration integration)

(experimental) The integration to be configured on this route.

Parameters:

integration - The integration to be configured on this route. This parameter is required.

Returns:

this

httpApi

public HttpRoute.Builder httpApi(IHttpApi httpApi)

(experimental) the API the route is associated with.

Parameters:

httpApi - the API the route is associated with. This parameter is required.

Returns:

this

routeKey

public HttpRoute.Builder routeKey(HttpRouteKey routeKey)

(experimental) The key to this route.

This is a combination of an HTTP method and an HTTP path.

Parameters:

routeKey - The key to this route. This parameter is required.

Returns:

this

authorizationScopes

public HttpRoute.Builder authorizationScopes(java.util.List<java.lang.String> authorizationScopes)

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

These scopes will be merged with the scopes from the attached authorizer

Default: - no additional authorization scopes

Parameters:

authorizationScopes - The list of OIDC scopes to include in the authorization. This parameter is required.

Returns:

this

authorizer

public HttpRoute.Builder authorizer(IHttpRouteAuthorizer authorizer)

(experimental) Authorizer for a WebSocket API or an HTTP API.

Default: - No authorizer

Parameters:

authorizer - Authorizer for a WebSocket API or an HTTP API. This parameter is required.

Returns:

this

build

public HttpRoute build()