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
-
Method Summary
Modifier and TypeMethodDescriptionauthorizationScopes
(List<String> authorizationScopes) Sets the value ofHttpRouteProps.getAuthorizationScopes()
authorizer
(IHttpRouteAuthorizer authorizer) Sets the value ofHttpRouteProps.getAuthorizer()
build()
Builds the configured instance.Sets the value ofHttpRouteProps.getHttpApi()
integration
(HttpRouteIntegration integration) Sets the value ofBatchHttpRouteOptions.getIntegration()
routeKey
(HttpRouteKey routeKey) Sets the value ofHttpRouteProps.getRouteKey()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
httpApi
Sets the value ofHttpRouteProps.getHttpApi()
- Parameters:
httpApi
- the API the route is associated with. This parameter is required.- Returns:
this
-
routeKey
Sets the value ofHttpRouteProps.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 ofHttpRouteProps.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
Sets the value ofHttpRouteProps.getAuthorizer()
- Parameters:
authorizer
- Authorizer for a WebSocket API or an HTTP API.- Returns:
this
-
integration
Sets the value ofBatchHttpRouteOptions.getIntegration()
- Parameters:
integration
- The integration to be configured on this route. This parameter is required.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<HttpRouteProps>
- Returns:
- a new instance of
HttpRouteProps
- Throws:
NullPointerException
- if any required attribute was not provided
-