Package software.amazon.awscdk.services.apigatewayv2

Class AddRoutesOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.AddRoutesOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AddRoutesOptions>

Enclosing interface:

AddRoutesOptions

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

A builder for AddRoutesOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AddRoutesOptions.Builder	authorizationScopes(List<String> authorizationScopes)	Sets the value of AddRoutesOptions.getAuthorizationScopes()
AddRoutesOptions.Builder	authorizer(IHttpRouteAuthorizer authorizer)	Sets the value of AddRoutesOptions.getAuthorizer()
AddRoutesOptions	build()	Builds the configured instance.
AddRoutesOptions.Builder	integration(HttpRouteIntegration integration)	Sets the value of BatchHttpRouteOptions.getIntegration()
AddRoutesOptions.Builder	methods(List<? extends HttpMethod> methods)	Sets the value of AddRoutesOptions.getMethods()
AddRoutesOptions.Builder	path(String path)	Sets the value of AddRoutesOptions.getPath()

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

path

@Stability(Experimental)
public AddRoutesOptions.Builder path(String path)

Sets the value of AddRoutesOptions.getPath()

Parameters:

path - The path at which all of these routes are configured. This parameter is required.

Returns:

this

authorizationScopes

@Stability(Experimental)
public AddRoutesOptions.Builder authorizationScopes(List<String> authorizationScopes)

Sets the value of AddRoutesOptions.getAuthorizationScopes()

Parameters:

authorizationScopes - 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

Returns:

this

authorizer

@Stability(Experimental)
public AddRoutesOptions.Builder authorizer(IHttpRouteAuthorizer authorizer)

Sets the value of AddRoutesOptions.getAuthorizer()

Parameters:

authorizer - Authorizer to be associated to these routes. Use NoneAuthorizer to remove the default authorizer for the api

Returns:

this

methods

@Stability(Experimental)
public AddRoutesOptions.Builder methods(List<? extends HttpMethod> methods)

Sets the value of AddRoutesOptions.getMethods()

Parameters:

methods - The HTTP methods to be configured.

Returns:

this

integration

@Stability(Experimental)
public AddRoutesOptions.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(Experimental)
public AddRoutesOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AddRoutesOptions

Throws:

NullPointerException - if any required attribute was not provided