Class: Aws::ApiGatewayV2::Types::CreateRouteInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::CreateRouteInput
- Defined in:
- gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb
Overview
Represents the input parameters for a CreateRoute request.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_key_required ⇒ Boolean
Specifies whether an API key is required for the route.
-
#authorization_scopes ⇒ Array<String>
The authorization scopes supported by this route.
-
#authorization_type ⇒ String
The authorization type for the route.
-
#authorizer_id ⇒ String
The identifier of the Authorizer resource to be associated with this route.
-
#model_selection_expression ⇒ String
The model selection expression for the route.
-
#operation_name ⇒ String
The operation name for the route.
-
#request_models ⇒ Hash<String,String>
The request models for the route.
-
#request_parameters ⇒ Hash<String,Types::ParameterConstraints>
The request parameters for the route.
-
#route_key ⇒ String
The route key for the route.
-
#route_response_selection_expression ⇒ String
The route response selection expression for the route.
-
#target ⇒ String
The target for the route.
Instance Attribute Details
#api_key_required ⇒ Boolean
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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>
The authorization scopes supported by this route.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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 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.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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 of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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
The model selection expression for the route. Supported only for WebSocket APIs.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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
The operation name for the route.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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 request models for the route. Supported only for WebSocket APIs.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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 request parameters for the route. Supported only for WebSocket APIs.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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
The route key for the route.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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
The route response selection expression for the route. Supported only for WebSocket APIs.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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
The target for the route.
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2301 class CreateRouteInput < Struct.new( :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 |