Interface ICfnRouteProps
Properties for defining a CfnRoute
.
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface ICfnRouteProps
Syntax (vb)
Public Interface ICfnRouteProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
var requestModels;
var requestParameters;
var cfnRouteProps = new CfnRouteProps {
ApiId = "apiId",
RouteKey = "routeKey",
// the properties below are optional
ApiKeyRequired = false,
AuthorizationScopes = new [] { "authorizationScopes" },
AuthorizationType = "authorizationType",
AuthorizerId = "authorizerId",
ModelSelectionExpression = "modelSelectionExpression",
OperationName = "operationName",
RequestModels = requestModels,
RequestParameters = requestParameters,
RouteResponseSelectionExpression = "routeResponseSelectionExpression",
Target = "target"
};
Synopsis
Properties
ApiId | The API identifier. |
ApiKeyRequired | Specifies whether an API key is required for the route. |
AuthorizationScopes | The authorization scopes supported by this route. |
AuthorizationType | The authorization type for the route. |
AuthorizerId | The identifier of the |
ModelSelectionExpression | The model selection expression for the route. |
OperationName | The operation name for the route. |
RequestModels | The request models for the route. |
RequestParameters | The request parameters for the route. |
RouteKey | The route key for the route. |
RouteResponseSelectionExpression | The route response selection expression for the route. |
Target | The target for the route. |
Properties
ApiId
The API identifier.
string ApiId { get; }
Property Value
System.String
Remarks
ApiKeyRequired
Specifies whether an API key is required for the route.
virtual object ApiKeyRequired { get; }
Property Value
System.Object
Remarks
Supported only for WebSocket APIs.
AuthorizationScopes
The authorization scopes supported by this route.
virtual string[] AuthorizationScopes { get; }
Property Value
System.String[]
Remarks
AuthorizationType
The authorization type for the route.
virtual string AuthorizationType { get; }
Property Value
System.String
Remarks
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
The identifier of the Authorizer
resource to be associated with this route.
virtual string AuthorizerId { get; }
Property Value
System.String
Remarks
The authorizer identifier is generated by API Gateway when you created the authorizer.
ModelSelectionExpression
The model selection expression for the route.
virtual string ModelSelectionExpression { get; }
Property Value
System.String
Remarks
Supported only for WebSocket APIs.
OperationName
The operation name for the route.
virtual string OperationName { get; }
Property Value
System.String
Remarks
RequestModels
The request models for the route.
virtual object RequestModels { get; }
Property Value
System.Object
Remarks
Supported only for WebSocket APIs.
RequestParameters
The request parameters for the route.
virtual object RequestParameters { get; }
Property Value
System.Object
Remarks
Supported only for WebSocket APIs.
RouteKey
The route key for the route.
string RouteKey { get; }
Property Value
System.String
Remarks
For HTTP APIs, the route key can be either $default
, or a combination of an HTTP method and resource path, for example, GET /pets
.
RouteResponseSelectionExpression
The route response selection expression for the route.
virtual string RouteResponseSelectionExpression { get; }
Property Value
System.String
Remarks
Supported only for WebSocket APIs.
Target
The target for the route.
virtual string Target { get; }
Property Value
System.String