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

Inherits:

Struct

Object
Struct
Aws::ApiGatewayV2::Types::Route

show all

Includes:: Structure

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

Overview

Represents a route.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#api_gateway_managed ⇒ Boolean

Specifies whether a route is managed by API Gateway.
#api_key_required ⇒ Boolean

Specifies whether an API key is required for this route.
#authorization_scopes ⇒ Array<String>

A list of authorization scopes configured on a 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_id ⇒ String

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

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)

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

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

#api_key_required ⇒ `Boolean`

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

Returns:

(Boolean)

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

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)
  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 5421

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

Returns:

(String)

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

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

Returns:

(String)

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

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

#model_selection_expression ⇒ `String`

The model selection expression for the route. Supported only for WebSocket APIs.

Returns:

(String)

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

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

#operation_name ⇒ `String`

The operation name for the route.

Returns:

(String)

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

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

#request_models ⇒ `Hash<String,String>`

The request models for the route. Supported only for WebSocket APIs.

Returns:

(Hash<String,String>)

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

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

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

The request parameters for the route. Supported only for WebSocket APIs.

Returns:

(Hash<String,Types::ParameterConstraints>)

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

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

#route_id ⇒ `String`

The route ID.

Returns:

(String)

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

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

#route_key ⇒ `String`

The route key for the route.

Returns:

(String)

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

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

#route_response_selection_expression ⇒ `String`

The route response selection expression for the route. Supported only for WebSocket APIs.

Returns:

(String)

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

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

#target ⇒ `String`

The target for the route.

Returns:

(String)

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

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

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

Overview

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`