aws-cdk-lib.aws_apigatewayv2.CfnRouteResponseProps

interface CfnRouteResponseProps

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnRouteResponseProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnRouteResponseProps
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnRouteResponseProps
Pythonaws_cdk.aws_apigatewayv2.CfnRouteResponseProps
TypeScript aws-cdk-lib » 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 { 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

NameTypeDescription
apiIdstringThe API identifier.
routeIdstringThe route ID.
routeResponseKeystringThe route response key.
modelSelectionExpression?stringThe model selection expression for the route response.
responseModels?anyThe 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.