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_gateway_managedBoolean

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.

Returns:

  • (Boolean)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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

#api_key_requiredBoolean

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

Returns:

  • (Boolean)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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 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.

Returns:

  • (Array<String>)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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. 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, or JWT for using JSON Web Tokens.

Returns:

  • (String)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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. The authorizer identifier is generated by API Gateway when you created the authorizer.

Returns:

  • (String)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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. Supported only for WebSocket APIs.

Returns:

  • (String)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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. Supported only for WebSocket APIs.

Returns:

  • (Hash<String,String>)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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. Supported only for WebSocket APIs.

Returns:



5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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. Supported only for WebSocket APIs.

Returns:

  • (String)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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)


5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5062

class Route < Struct.new(
  :api_gateway_managed,
  :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