class Aws::ApiGatewayV2::Types::CreateRouteRequest
@note When making an API call, you may pass CreateRouteRequest
data as a hash: { api_id: "__string", # required api_key_required: false, authorization_scopes: ["StringWithLengthBetween1And64"], authorization_type: "NONE", # accepts NONE, AWS_IAM, CUSTOM, JWT authorizer_id: "Id", model_selection_expression: "SelectionExpression", operation_name: "StringWithLengthBetween1And64", request_models: { "__string" => "StringWithLengthBetween1And128", }, request_parameters: { "__string" => { required: false, }, }, route_key: "SelectionKey", # required route_response_selection_expression: "SelectionExpression", target: "StringWithLengthBetween1And128", }
@!attribute [rw] api_id
@return [String]
@!attribute [rw] api_key_required
@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 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. @return [String]
@!attribute [rw] model_selection_expression
An expression used to extract information at runtime. See [Selection Expressions][1] for more information. [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions @return [String]
@!attribute [rw] operation_name
A string with a length between \[1-64\]. @return [String]
@!attribute [rw] request_models
The route models. @return [Hash<String,String>]
@!attribute [rw] request_parameters
The route parameters. @return [Hash<String,Types::ParameterConstraints>]
@!attribute [rw] route_key
After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See [Selection Expressions][1] for a list of expressions and each expression's associated selection key type. [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions @return [String]
@!attribute [rw] route_response_selection_expression
An expression used to extract information at runtime. See [Selection Expressions][1] for more information. [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions @return [String]
@!attribute [rw] target
A string with a length between \[1-128\]. @return [String]
Constants
- SENSITIVE