Interface ICfnRouteResponseProps
Properties for defining a CfnRouteResponse
.
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface ICfnRouteResponseProps
Syntax (vb)
Public Interface ICfnRouteResponseProps
Remarks
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 responseModels;
var cfnRouteResponseProps = new CfnRouteResponseProps {
ApiId = "apiId",
RouteId = "routeId",
RouteResponseKey = "routeResponseKey",
// the properties below are optional
ModelSelectionExpression = "modelSelectionExpression",
ResponseModels = responseModels,
ResponseParameters = new Dictionary<string, object> {
{ "responseParametersKey", new ParameterConstraintsProperty {
Required = false
} }
}
};
Synopsis
Properties
ApiId | The API identifier. |
ModelSelectionExpression | The model selection expression for the route response. |
ResponseModels | The response models for the route response. |
ResponseParameters | The route response parameters. |
RouteId | The route ID. |
RouteResponseKey | The route response key. |
Properties
ApiId
The API identifier.
string ApiId { get; }
Property Value
System.String
Remarks
ModelSelectionExpression
The model selection expression for the route response.
virtual string ModelSelectionExpression { get; }
Property Value
System.String
Remarks
Supported only for WebSocket APIs.
ResponseModels
The response models for the route response.
virtual object ResponseModels { get; }
Property Value
System.Object
Remarks
ResponseParameters
The route response parameters.
virtual object ResponseParameters { get; }
Property Value
System.Object
Remarks
RouteId
The route ID.
string RouteId { get; }
Property Value
System.String
Remarks
RouteResponseKey
The route response key.
string RouteResponseKey { get; }
Property Value
System.String