class Aws::ApiGatewayV2::Types::Route

Represents a route.

@!attribute [rw] api_gateway_managed

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.
@return [Boolean]

@!attribute [rw] api_key_required

Specifies whether an API key is required for this route. Supported
only for WebSocket APIs.
@return [Boolean]

@!attribute [rw] authorization_scopes

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.
@return [Array<String>]

@!attribute [rw] authorization_type

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.
@return [String]

@!attribute [rw] authorizer_id

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.
@return [String]

@!attribute [rw] model_selection_expression

The model selection expression for the route. Supported only for
WebSocket APIs.
@return [String]

@!attribute [rw] operation_name

The operation name for the route.
@return [String]

@!attribute [rw] request_models

The request models for the route. Supported only for WebSocket APIs.
@return [Hash<String,String>]

@!attribute [rw] request_parameters

The request parameters for the route. Supported only for WebSocket
APIs.
@return [Hash<String,Types::ParameterConstraints>]

@!attribute [rw] route_id

The route ID.
@return [String]

@!attribute [rw] route_key

The route key for the route.
@return [String]

@!attribute [rw] route_response_selection_expression

The route response selection expression for the route. Supported
only for WebSocket APIs.
@return [String]

@!attribute [rw] target

The target for the route.
@return [String]

Constants

SENSITIVE