AWS SDK Version 3 for .NET
API Reference

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.

Container for the parameters to the CreateRoute operation. Creates a Route for an API.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ApiGatewayV2.AmazonApiGatewayV2Request
      Amazon.ApiGatewayV2.Model.CreateRouteRequest

Namespace: Amazon.ApiGatewayV2.Model
Assembly: AWSSDK.ApiGatewayV2.dll
Version: 3.x.y.z

Syntax

C#
public class CreateRouteRequest : AmazonApiGatewayV2Request
         IAmazonWebServiceRequest

The CreateRouteRequest type exposes the following members

Constructors

NameDescription
Public Method CreateRouteRequest()

Properties

NameTypeDescription
Public Property ApiId System.String

Gets and sets the property ApiId.

The API identifier.

Public Property ApiKeyRequired System.Boolean

Gets and sets the property ApiKeyRequired.

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

Public Property AuthorizationScopes System.Collections.Generic.List<System.String>

Gets and sets the property AuthorizationScopes.

The authorization scopes supported by this route.

Public Property AuthorizationType Amazon.ApiGatewayV2.AuthorizationType

Gets and sets the property AuthorizationType.

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.

Public Property AuthorizerId System.String

Gets and sets the property AuthorizerId.

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.

Public Property ModelSelectionExpression System.String

Gets and sets the property ModelSelectionExpression.

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

Public Property OperationName System.String

Gets and sets the property OperationName.

The operation name for the route.

Public Property RequestModels System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property RequestModels.

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

Public Property RequestParameters System.Collections.Generic.Dictionary<System.String, Amazon.ApiGatewayV2.Model.ParameterConstraints>

Gets and sets the property RequestParameters.

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

Public Property RouteKey System.String

Gets and sets the property RouteKey.

The route key for the route.

Public Property RouteResponseSelectionExpression System.String

Gets and sets the property RouteResponseSelectionExpression.

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

Public Property Target System.String

Gets and sets the property Target.

The target for the route.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms