Interface Route.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Route.Builder,
,Route> SdkBuilder<Route.Builder,
,Route> SdkPojo
- Enclosing class:
Route
-
Method Summary
Modifier and TypeMethodDescriptionapiGatewayManaged
(Boolean apiGatewayManaged) Specifies whether a route is managed by API Gateway.apiKeyRequired
(Boolean apiKeyRequired) Specifies whether an API key is required for this route.authorizationScopes
(String... authorizationScopes) A list of authorization scopes configured on a route.authorizationScopes
(Collection<String> authorizationScopes) A list of authorization scopes configured on a route.authorizationType
(String authorizationType) The authorization type for the route.authorizationType
(AuthorizationType authorizationType) The authorization type for the route.authorizerId
(String authorizerId) The identifier of the Authorizer resource to be associated with this route.modelSelectionExpression
(String modelSelectionExpression) The model selection expression for the route.operationName
(String operationName) The operation name for the route.requestModels
(Map<String, String> requestModels) The request models for the route.requestParameters
(Map<String, ParameterConstraints> requestParameters) The request parameters for the route.The route ID.The route key for the route.routeResponseSelectionExpression
(String routeResponseSelectionExpression) The route response selection expression for the route.The target for the route.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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:
-
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
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
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
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
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
The route ID.
- Parameters:
routeId
- The route ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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.
-