Package software.amazon.awscdk.services.apigatewayv2

Interface HttpRouteProps

All Superinterfaces:

BatchHttpRouteOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:10.756Z")
@Stability(Stable)
public interface HttpRouteProps
extends software.amazon.jsii.JsiiSerializable, BatchHttpRouteOptions

Properties to initialize a new 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.*;
 HttpApi httpApi;
 IHttpRouteAuthorizer httpRouteAuthorizer;
 HttpRouteIntegration httpRouteIntegration;
 HttpRouteKey httpRouteKey;
 HttpRouteProps httpRouteProps = HttpRouteProps.builder()
         .httpApi(httpApi)
         .integration(httpRouteIntegration)
         .routeKey(httpRouteKey)
         // the properties below are optional
         .authorizationScopes(List.of("authorizationScopes"))
         .authorizer(httpRouteAuthorizer)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpRouteProps.Builder	builder()
default List<String>	getAuthorizationScopes()	The list of OIDC scopes to include in the authorization.
default IHttpRouteAuthorizer	getAuthorizer()	Authorizer for a WebSocket API or an HTTP API.
IHttpApi	getHttpApi()	the API the route is associated with.
HttpRouteKey	getRouteKey()	The key to this route.

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

getIntegration

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHttpApi

@Stability(Stable)
@NotNull
IHttpApi getHttpApi()

the API the route is associated with.

getRouteKey

@Stability(Stable)
@NotNull
HttpRouteKey getRouteKey()

The key to this route.

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

getAuthorizationScopes

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

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

getAuthorizer

@Stability(Stable)
@Nullable
default IHttpRouteAuthorizer getAuthorizer()

Authorizer for a WebSocket API or an HTTP API.

Default: - No authorizer

builder

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

Returns:

a HttpRouteProps.Builder of HttpRouteProps