interface CfnRouteResponseProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGatewayv2.CfnRouteResponseProps
Java	software.amazon.awscdk.services.apigatewayv2.CfnRouteResponseProps
Python	aws_cdk.aws_apigatewayv2.CfnRouteResponseProps
TypeScript	@aws-cdk/aws-apigatewayv2 » CfnRouteResponseProps

Properties for defining a CfnRouteResponse.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';

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

Name	Type	Description
apiId	string	The API identifier.
routeId	string	The route ID.
routeResponseKey	string	The route response key.
modelSelectionExpression?	string	The model selection expression for the route response.
responseModels?	any	The response models for the route response.
responseParameters?	IResolvable | { [string]: IResolvable | ParameterConstraintsProperty }	The route response parameters.

---

apiId

Type: string

The API identifier.

---

routeId

Type: string

The route ID.

---

routeResponseKey

Type: string

The route response key.

---

modelSelectionExpression?

Type: string (optional)

The model selection expression for the route response.

Supported only for WebSocket APIs.

---

responseModels?

Type: any (optional)

The response models for the route response.

---

responseParameters?

Type: IResolvable | { [string]: IResolvable | ParameterConstraintsProperty } (optional)

The route response parameters.