You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::Route

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents a route.

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_requiredBoolean

Specifies whether an API key is required for this route.

Returns:

  • (Boolean)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#authorization_scopesArray<String>

A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS 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.

Returns:

  • (Array<String>)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#authorization_typeString

The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer

Returns:

  • (String)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#authorizer_idString

The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

Returns:

  • (String)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#model_selection_expressionString

The model selection expression for the route.

Returns:

  • (String)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#operation_nameString

The operation name for the route.

Returns:

  • (String)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#request_modelsHash<String,String>

The request models for the route.

Returns:

  • (Hash<String,String>)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#request_parametersHash<String,Types::ParameterConstraints>

The request parameters for the route.

Returns:



4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#route_idString

The route ID.

Returns:

  • (String)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#route_keyString

The route key for the route.

Returns:

  • (String)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#route_response_selection_expressionString

The route response selection expression for the route.

Returns:

  • (String)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end

#targetString

The target for the route.

Returns:

  • (String)


4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4323

class Route < Struct.new(
  :api_key_required,
  :authorization_scopes,
  :authorization_type,
  :authorizer_id,
  :model_selection_expression,
  :operation_name,
  :request_models,
  :request_parameters,
  :route_id,
  :route_key,
  :route_response_selection_expression,
  :target)
  include Aws::Structure
end