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

Inherits:

Struct

Object
Struct
Aws::ApiGatewayV2::Types::GetRouteResult

show all

Includes:: Structure

Defined in:: lib/aws-sdk-apigatewayv2/types.rb

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#api_gateway_managed ⇒ Boolean
#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_id ⇒ String

The identifier.
#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_gateway_managed ⇒ `Boolean`

Returns:

(Boolean)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_required ⇒ `Boolean`

Returns:

(Boolean)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_type ⇒ `String`

The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using Amazon Web Services 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 Amazon Web Services IAM permissions, and CUSTOM for using a Lambda authorizer.

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_id ⇒ `String`

The identifier.

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_expression ⇒ `String`

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

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_models ⇒ `Hash<String,String>`

The route models.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_parameters ⇒ `Hash<String,Types::ParameterConstraints>`

The route parameters.

Returns:

(Hash<String,Types::ParameterConstraints>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_id ⇒ `String`

The identifier.

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_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][1: for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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_expression ⇒ `String`

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

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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

#target ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5717

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

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

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#api_gateway_managed ⇒ Boolean

#api_key_required ⇒ Boolean

#authorization_scopes ⇒ Array<String>

#authorization_type ⇒ String

#authorizer_id ⇒ String

#model_selection_expression ⇒ String

#operation_name ⇒ String

#request_models ⇒ Hash<String,String>

#request_parameters ⇒ Hash<String,Types::ParameterConstraints>

#route_id ⇒ String

#route_key ⇒ String

#route_response_selection_expression ⇒ String

#target ⇒ String

#api_gateway_managed ⇒ `Boolean`

#api_key_required ⇒ `Boolean`

#authorization_scopes ⇒ `Array<String>`

#authorization_type ⇒ `String`

#authorizer_id ⇒ `String`

#model_selection_expression ⇒ `String`

#operation_name ⇒ `String`

#request_models ⇒ `Hash<String,String>`

#request_parameters ⇒ `Hash<String,Types::ParameterConstraints>`

#route_id ⇒ `String`

#route_key ⇒ `String`

#route_response_selection_expression ⇒ `String`

#target ⇒ `String`