This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project,
feel free to reach out to us!aws_apigatewayv2_route
account_id
Type: STRING
api_gateway_managed
Type: BOOLEAN
Provider name: ApiGatewayManaged
Description: 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.
api_key_required
Type: BOOLEAN
Provider name: ApiKeyRequired
Description: Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
authorization_scopes
Type: UNORDERED_LIST_STRING
Provider name: AuthorizationScopes
Description: 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.
authorization_type
Type: STRING
Provider name: AuthorizationType
Description: 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.
authorizer_id
Type: STRING
Provider name: AuthorizerId
Description: 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.
model_selection_expression
Type: STRING
Provider name: ModelSelectionExpression
Description: The model selection expression for the route. Supported only for WebSocket APIs.
operation_name
Type: STRING
Provider name: OperationName
Description: The operation name for the route.
request_models
Type: MAP_STRING_STRING
Provider name: RequestModels
Description: The request models for the route. Supported only for WebSocket APIs.
request_parameters
Type: STRING
Provider name: RequestParameters
Description: The request parameters for the route. Supported only for WebSocket APIs.
route_arn
Type: STRING
route_id
Type: STRING
Provider name: RouteId
Description: The route ID.
route_key
Type: STRING
Provider name: RouteKey
Description: The route key for the route.
route_response_selection_expression
Type: STRING
Provider name: RouteResponseSelectionExpression
Description: The route response selection expression for the route. Supported only for WebSocket APIs.
Type: UNORDERED_LIST_STRING
target
Type: STRING
Provider name: Target
Description: The target for the route.
