Class: Aws::ApiGatewayV2::Types::CreateRouteRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::CreateRouteRequest
- Defined in:
- gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_id ⇒ String
-
#api_key_required ⇒ Boolean
-
#authorization_scopes ⇒ Array<String>
A list of authorization scopes configured on a route.
-
#authorization_type ⇒ String
The authorization type.
-
#authorizer_id ⇒ String
The identifier.
-
#model_selection_expression ⇒ String
An expression used to extract information at runtime.
-
#operation_name ⇒ String
A string with a length between [1-64].
-
#request_models ⇒ Hash<String,String>
The route models.
-
#request_parameters ⇒ Hash<String,Types::ParameterConstraints>
The route parameters.
-
#route_key ⇒ String
After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key.
-
#route_response_selection_expression ⇒ String
An expression used to extract information at runtime.
-
#target ⇒ String
A string with a length between [1-128].
Instance Attribute Details
#api_id ⇒ String
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#api_key_required ⇒ Boolean
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#authorization_scopes ⇒ Array<String>
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.
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#authorization_type ⇒ String
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.
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#authorizer_id ⇒ String
The identifier.
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#model_selection_expression ⇒ String
An expression used to extract information at runtime. See Selection Expressions for more information.
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#operation_name ⇒ String
A string with a length between [1-64].
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#request_models ⇒ Hash<String,String>
The route models.
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#request_parameters ⇒ Hash<String,Types::ParameterConstraints>
The route parameters.
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#route_key ⇒ String
After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#route_response_selection_expression ⇒ String
An expression used to extract information at runtime. See Selection Expressions for more information.
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |
#target ⇒ String
A string with a length between [1-128].
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2245 class CreateRouteRequest < Struct.new( :api_id, :api_key_required, :authorization_scopes, :authorization_type, :authorizer_id, :model_selection_expression, :operation_name, :request_models, :request_parameters, :route_key, :route_response_selection_expression, :target) SENSITIVE = [] include Aws::Structure end |