apigatewayv2/aws.sdk.kotlin.services.apigatewayv2.model/UpdateRouteRequest

UpdateRouteRequest

class UpdateRouteRequest

Updates a Route.

Types

object Companion

Properties

val apiId: String?

The API identifier.

val apiKeyRequired: Boolean?

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

authorizationScopes

val authorizationScopes: List<String>?

The authorization scopes supported by this route.

authorizationType

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

val authorizerId: String?

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

val modelSelectionExpression: String?

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

val operationName: String?

The operation name for the route.

val requestModels: Map<String, String>?

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

requestParameters

val requestParameters: Map<String, ParameterConstraints>?

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

val routeId: String?

The route ID.

val routeKey: String?

The route key for the route.

routeResponseSelectionExpression

val routeResponseSelectionExpression: String?

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

val target: String?

The target for the route.

Functions

inline fun copy(block: UpdateRouteRequest.Builder.() -> Unit = {}): UpdateRouteRequest

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String