Package software.amazon.awscdk.services.apigatewayv2

Class HttpRouteProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpRouteProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpRouteProps>

Enclosing interface:

HttpRouteProps

@Stability(Stable)
public static final class HttpRouteProps.Builder
extends Object
implements software.amazon.jsii.Builder<HttpRouteProps>

A builder for HttpRouteProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpRouteProps.Builder	authorizationScopes(List<String> authorizationScopes)	Sets the value of HttpRouteProps.getAuthorizationScopes()
HttpRouteProps.Builder	authorizer(IHttpRouteAuthorizer authorizer)	Sets the value of HttpRouteProps.getAuthorizer()
HttpRouteProps	build()	Builds the configured instance.
HttpRouteProps.Builder	httpApi(IHttpApi httpApi)	Sets the value of HttpRouteProps.getHttpApi()
HttpRouteProps.Builder	integration(HttpRouteIntegration integration)	Sets the value of BatchHttpRouteOptions.getIntegration()
HttpRouteProps.Builder	routeKey(HttpRouteKey routeKey)	Sets the value of HttpRouteProps.getRouteKey()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

httpApi

@Stability(Stable)
public HttpRouteProps.Builder httpApi(IHttpApi httpApi)

Sets the value of HttpRouteProps.getHttpApi()

Parameters:

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

Returns:

this

routeKey

@Stability(Stable)
public HttpRouteProps.Builder routeKey(HttpRouteKey routeKey)

Sets the value of HttpRouteProps.getRouteKey()

Parameters:

routeKey - The key to this route. This parameter is required. This is a combination of an HTTP method and an HTTP path.

Returns:

this

authorizationScopes

@Stability(Stable)
public HttpRouteProps.Builder authorizationScopes(List<String> authorizationScopes)

Sets the value of HttpRouteProps.getAuthorizationScopes()

Parameters:

authorizationScopes - The list of OIDC scopes to include in the authorization. These scopes will be merged with the scopes from the attached authorizer

Returns:

this

authorizer

@Stability(Stable)
public HttpRouteProps.Builder authorizer(IHttpRouteAuthorizer authorizer)

Sets the value of HttpRouteProps.getAuthorizer()

Parameters:

authorizer - Authorizer for a WebSocket API or an HTTP API.

Returns:

this

integration

@Stability(Stable)
public HttpRouteProps.Builder integration(HttpRouteIntegration integration)

Sets the value of BatchHttpRouteOptions.getIntegration()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public HttpRouteProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<HttpRouteProps>

Returns:

a new instance of HttpRouteProps

Throws:

NullPointerException - if any required attribute was not provided