Class: Aws::ApiGatewayV2::Types::GetRouteResult

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_gateway_managedBoolean

Returns:

  • (Boolean)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#api_key_requiredBoolean

Returns:

  • (Boolean)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  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>)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#authorization_typeString

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, or JWT for using JSON Web Tokens.

Returns:

  • (String)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_idString

The identifier.

Returns:

  • (String)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#model_selection_expressionString

An expression used to extract information at runtime. See Selection Expressions for more information.

Returns:

  • (String)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#operation_nameString

A string with a length between [1-64].

Returns:

  • (String)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#request_modelsHash<String,String>

The route models.

Returns:

  • (Hash<String,String>)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#request_parametersHash<String,Types::ParameterConstraints>

The route parameters.

Returns:



4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#route_idString

The identifier.

Returns:

  • (String)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#route_keyString

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.

Returns:

  • (String)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#route_response_selection_expressionString

An expression used to extract information at runtime. See Selection Expressions for more information.

Returns:

  • (String)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end

#targetString

A string with a length between [1-128].

Returns:

  • (String)


4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4343

class GetRouteResult < 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)
  SENSITIVE = []
  include Aws::Structure
end