| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ApiGatewayV2.Types.Route
Description
Synopsis
- data Route = Route' {
- authorizationScopes :: Maybe [Text]
- modelSelectionExpression :: Maybe Text
- requestModels :: Maybe (HashMap Text Text)
- routeResponseSelectionExpression :: Maybe Text
- requestParameters :: Maybe (HashMap Text ParameterConstraints)
- routeId :: Maybe Text
- authorizerId :: Maybe Text
- operationName :: Maybe Text
- apiGatewayManaged :: Maybe Bool
- authorizationType :: Maybe AuthorizationType
- apiKeyRequired :: Maybe Bool
- target :: Maybe Text
- routeKey :: Text
- newRoute :: Text -> Route
- route_authorizationScopes :: Lens' Route (Maybe [Text])
- route_modelSelectionExpression :: Lens' Route (Maybe Text)
- route_requestModels :: Lens' Route (Maybe (HashMap Text Text))
- route_routeResponseSelectionExpression :: Lens' Route (Maybe Text)
- route_requestParameters :: Lens' Route (Maybe (HashMap Text ParameterConstraints))
- route_routeId :: Lens' Route (Maybe Text)
- route_authorizerId :: Lens' Route (Maybe Text)
- route_operationName :: Lens' Route (Maybe Text)
- route_apiGatewayManaged :: Lens' Route (Maybe Bool)
- route_authorizationType :: Lens' Route (Maybe AuthorizationType)
- route_apiKeyRequired :: Lens' Route (Maybe Bool)
- route_target :: Lens' Route (Maybe Text)
- route_routeKey :: Lens' Route Text
Documentation
Represents a route.
See: newRoute smart constructor.
Constructors
| Route' | |
Fields
| |
Instances
Create a value of Route with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authorizationScopes:Route', route_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.
$sel:modelSelectionExpression:Route', route_modelSelectionExpression - The model selection expression for the route. Supported only for
WebSocket APIs.
$sel:requestModels:Route', route_requestModels - The request models for the route. Supported only for WebSocket APIs.
$sel:routeResponseSelectionExpression:Route', route_routeResponseSelectionExpression - The route response selection expression for the route. Supported only
for WebSocket APIs.
$sel:requestParameters:Route', route_requestParameters - The request parameters for the route. Supported only for WebSocket APIs.
$sel:routeId:Route', route_routeId - The route ID.
$sel:authorizerId:Route', route_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.
$sel:operationName:Route', route_operationName - The operation name for the route.
$sel:apiGatewayManaged:Route', route_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.
$sel:authorizationType:Route', route_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.
$sel:apiKeyRequired:Route', route_apiKeyRequired - Specifies whether an API key is required for this route. Supported only
for WebSocket APIs.
$sel:target:Route', route_target - The target for the route.
$sel:routeKey:Route', route_routeKey - The route key for the route.
route_authorizationScopes :: Lens' Route (Maybe [Text]) Source #
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.
route_modelSelectionExpression :: Lens' Route (Maybe Text) Source #
The model selection expression for the route. Supported only for WebSocket APIs.
route_requestModels :: Lens' Route (Maybe (HashMap Text Text)) Source #
The request models for the route. Supported only for WebSocket APIs.
route_routeResponseSelectionExpression :: Lens' Route (Maybe Text) Source #
The route response selection expression for the route. Supported only for WebSocket APIs.
route_requestParameters :: Lens' Route (Maybe (HashMap Text ParameterConstraints)) Source #
The request parameters for the route. Supported only for WebSocket APIs.
route_authorizerId :: Lens' Route (Maybe Text) Source #
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.
route_apiGatewayManaged :: Lens' Route (Maybe Bool) Source #
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.
route_authorizationType :: Lens' Route (Maybe AuthorizationType) Source #
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.