software.amazon.awssdk.services.apigatewayv2.model

Interface Route.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Route.Builder,Route>, SdkBuilder<Route.Builder,Route>, SdkPojo

Enclosing class:

Route

public static interface Route.Builder
extends SdkPojo, CopyableBuilder<Route.Builder,Route>

Method Summary

Modifier and Type	Method and Description
Route.Builder	apiGatewayManaged(Boolean apiGatewayManaged) Specifies whether a route is managed by API Gateway.
Route.Builder	apiKeyRequired(Boolean apiKeyRequired) Specifies whether an API key is required for this route.
Route.Builder	authorizationScopes(Collection<String> authorizationScopes) A list of authorization scopes configured on a route.
Route.Builder	authorizationScopes(String... authorizationScopes) A list of authorization scopes configured on a route.
Route.Builder	authorizationType(AuthorizationType authorizationType) The authorization type for the route.
Route.Builder	authorizationType(String authorizationType) The authorization type for the route.
Route.Builder	authorizerId(String authorizerId) The identifier of the Authorizer resource to be associated with this route.
Route.Builder	modelSelectionExpression(String modelSelectionExpression) The model selection expression for the route.
Route.Builder	operationName(String operationName) The operation name for the route.
Route.Builder	requestModels(Map<String,String> requestModels) The request models for the route.
Route.Builder	requestParameters(Map<String,ParameterConstraints> requestParameters) The request parameters for the route.
Route.Builder	routeId(String routeId) The route ID.
Route.Builder	routeKey(String routeKey) The route key for the route.
Route.Builder	routeResponseSelectionExpression(String routeResponseSelectionExpression) The route response selection expression for the route.
Route.Builder	target(String target) The target for the route.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

apiGatewayManaged

Route.Builder apiGatewayManaged(Boolean apiGatewayManaged)

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

Parameters:

apiGatewayManaged - Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiKeyRequired

Route.Builder apiKeyRequired(Boolean apiKeyRequired)

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

Parameters:

apiKeyRequired - Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

authorizationScopes

Route.Builder authorizationScopes(Collection<String> authorizationScopes)

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Parameters:

authorizationScopes - A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Returns:

Returns a reference to this object so that method calls can be chained together.

authorizationScopes

Route.Builder authorizationScopes(String... authorizationScopes)

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Parameters:

authorizationScopes - A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Returns:

Returns a reference to this object so that method calls can be chained together.

authorizationType

Route.Builder authorizationType(String authorizationType)

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Parameters:

authorizationType - The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthorizationType, AuthorizationType

authorizationType

Route.Builder authorizationType(AuthorizationType authorizationType)

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Parameters:

authorizationType - The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthorizationType, AuthorizationType

authorizerId

Route.Builder authorizerId(String authorizerId)

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

Parameters:

authorizerId - The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

Returns:

Returns a reference to this object so that method calls can be chained together.

modelSelectionExpression

Route.Builder modelSelectionExpression(String modelSelectionExpression)

The model selection expression for the route. Supported only for WebSocket APIs.

Parameters:

modelSelectionExpression - The model selection expression for the route. Supported only for WebSocket APIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

operationName

Route.Builder operationName(String operationName)

The operation name for the route.

Parameters:

operationName - The operation name for the route.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestModels

Route.Builder requestModels(Map<String,String> requestModels)

The request models for the route. Supported only for WebSocket APIs.

Parameters:

requestModels - The request models for the route. Supported only for WebSocket APIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestParameters

Route.Builder requestParameters(Map<String,ParameterConstraints> requestParameters)

The request parameters for the route. Supported only for WebSocket APIs.

Parameters:

requestParameters - The request parameters for the route. Supported only for WebSocket APIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

routeId

Route.Builder routeId(String routeId)

The route ID.

Parameters:

routeId - The route ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

routeKey

Route.Builder routeKey(String routeKey)

The route key for the route.

Parameters:

routeKey - The route key for the route.

Returns:

Returns a reference to this object so that method calls can be chained together.

routeResponseSelectionExpression

Route.Builder routeResponseSelectionExpression(String routeResponseSelectionExpression)

The route response selection expression for the route. Supported only for WebSocket APIs.

Parameters:

routeResponseSelectionExpression - The route response selection expression for the route. Supported only for WebSocket APIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

target

Route.Builder target(String target)

The target for the route.

Parameters:

target - The target for the route.

Returns:

Returns a reference to this object so that method calls can be chained together.