CfnRouteResponseProps Struct
Properties for defining a CfnRouteResponse.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
declare const responseModels: any;
const cfnRouteResponseProps: apigatewayv2.CfnRouteResponseProps = {
apiId: 'apiId',
routeId: 'routeId',
routeResponseKey: 'routeResponseKey',
// the properties below are optional
modelSelectionExpression: 'modelSelectionExpression',
responseModels: responseModels,
responseParameters: {
responseParametersKey: {
required: false,
},
},
};
Properties
apiIdstring | IApiRefapi_idtyping.Union[str, IApiRef]apiIdStringApiIdstringApiIdinterface{}required#The API identifier.
modelSelectionExpressionoptionalstringmodel_selection_expressionoptionalstrmodelSelectionExpressionoptionalStringModelSelectionExpressionoptionalstringModelSelectionExpressionoptional*string#The model selection expression for the route response.
Supported only for WebSocket APIs.
responseModelsoptionalanyresponse_modelsoptionalAnyresponseModelsoptionalObjectResponseModelsoptionalobjectResponseModelsoptionalinterface{}#The response models for the route response.
responseParametersoptionalIResolvable | { [key: string]: IResolvable | CfnRouteResponse.ParameterConstraintsProperty }response_parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, ParameterConstraintsProperty]]]responseParametersoptionalIResolvableResponseParametersoptionalIResolvableResponseParametersoptionalinterface{}#The route response parameters.
routeIdstring | IRouteRefroute_idtyping.Union[str, IRouteRef]routeIdStringRouteIdstringRouteIdinterface{}required#The route ID.
routeResponseKeystringroute_response_keystrrouteResponseKeyStringRouteResponseKeystringRouteResponseKey*stringrequired#The route response key.