Skip to content

Updates a Route

Description

Updates a Route.

Usage

apigatewayv2_update_route(ApiId, ApiKeyRequired, AuthorizationScopes,
  AuthorizationType, AuthorizerId, ModelSelectionExpression,
  OperationName, RequestModels, RequestParameters, RouteId, RouteKey,
  RouteResponseSelectionExpression, Target)

Arguments

  • ApiId

    [required] The API identifier.

  • ApiKeyRequired

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

  • AuthorizationScopes

    The authorization scopes supported by this 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.

  • 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.

  • ModelSelectionExpression

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

  • OperationName

    The operation name for the route.

  • RequestModels

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

  • RequestParameters

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

  • RouteId

    [required] The route ID.

  • RouteKey

    The route key for the route.

  • RouteResponseSelectionExpression

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

  • Target

    The target for the route.

Value

A list with the following syntax:

list(
  ApiGatewayManaged = TRUE|FALSE,
  ApiKeyRequired = TRUE|FALSE,
  AuthorizationScopes = list(
    "string"
  ),
  AuthorizationType = "NONE"|"AWS_IAM"|"CUSTOM"|"JWT",
  AuthorizerId = "string",
  ModelSelectionExpression = "string",
  OperationName = "string",
  RequestModels = list(
    "string"
  ),
  RequestParameters = list(
    list(
      Required = TRUE|FALSE
    )
  ),
  RouteId = "string",
  RouteKey = "string",
  RouteResponseSelectionExpression = "string",
  Target = "string"
)

Request syntax

svc$update_route(
  ApiId = "string",
  ApiKeyRequired = TRUE|FALSE,
  AuthorizationScopes = list(
    "string"
  ),
  AuthorizationType = "NONE"|"AWS_IAM"|"CUSTOM"|"JWT",
  AuthorizerId = "string",
  ModelSelectionExpression = "string",
  OperationName = "string",
  RequestModels = list(
    "string"
  ),
  RequestParameters = list(
    list(
      Required = TRUE|FALSE
    )
  ),
  RouteId = "string",
  RouteKey = "string",
  RouteResponseSelectionExpression = "string",
  Target = "string"
)