AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::ApiGatewayV2::Types::CreateRouteInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents the input parameters for a CreateRoute request.

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_requiredBoolean

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

Returns:

  • (Boolean)

    Specifies whether an API key is required for the route.

#authorization_scopesArray<String>

The authorization scopes supported by this route.

Returns:

  • (Array<String>)

    The authorization scopes supported by this route.

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

Possible values:

  • NONE
  • AWS_IAM
  • CUSTOM
  • JWT

Returns:

  • (String)

    The authorization type for the route.

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

    The identifier of the Authorizer resource to be associated with this route.

#model_selection_expressionString

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

Returns:

  • (String)

    The model selection expression for the route.

#operation_nameString

The operation name for the route.

Returns:

  • (String)

    The operation name for the route.

#request_modelsHash<String,String>

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

Returns:

  • (Hash<String,String>)

    The request models for the route.

#request_parametersHash<String,Types::ParameterConstraints>

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

Returns:

#route_keyString

The route key for the route.

Returns:

  • (String)

    The route key for the route.

#route_response_selection_expressionString

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

Returns:

  • (String)

    The route response selection expression for the route.

#targetString

The target for the route.

Returns:

  • (String)

    The target for the route.