Container for the parameters to the CreateRoute operation. Creates a Route for an API.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.ApiGatewayV2.AmazonApiGatewayV2Request
Amazon.ApiGatewayV2.Model.CreateRouteRequest
Namespace: Amazon.ApiGatewayV2.Model
Assembly: AWSSDK.ApiGatewayV2.dll
Version: 3.x.y.z
Syntax
public class CreateRouteRequest : AmazonApiGatewayV2Request IAmazonWebServiceRequest
The CreateRouteRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateRouteRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ApiId | System.String |
Gets and sets the property ApiId. The API identifier. |
|
|
ApiKeyRequired | System.Boolean |
Gets and sets the property ApiKeyRequired. Specifies whether an API key is required for the route. Supported only for WebSocket APIs. |
|
|
AuthorizationScopes | System.Collections.Generic.List<System.String> |
Gets and sets the property AuthorizationScopes. The authorization scopes supported by this route. |
|
|
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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. |
|
|
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. |
|
|
ModelSelectionExpression | System.String |
Gets and sets the property ModelSelectionExpression. The model selection expression for the route. Supported only for WebSocket APIs. |
|
|
OperationName | System.String |
Gets and sets the property OperationName. The operation name for the route. |
|
|
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. |
|
|
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. |
|
|
RouteKey | System.String |
Gets and sets the property RouteKey. The route key for the route. |
|
|
RouteResponseSelectionExpression | System.String |
Gets and sets the property RouteResponseSelectionExpression. The route response selection expression for the route. Supported only for WebSocket APIs. |
|
|
Target | System.String |
Gets and sets the property Target. The target for the route. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5