interface CfnRouteResponseMixinProps
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins.CfnRouteResponseMixinProps |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigatewayv2/mixins#CfnRouteResponseMixinProps |
Java | software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnRouteResponseMixinProps |
Python | aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnRouteResponseMixinProps |
TypeScript | @aws-cdk/mixins-preview » aws_apigatewayv2 » mixins » CfnRouteResponseMixinProps |
Properties for CfnRouteResponsePropsMixin.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as apigatewayv2_mixins } from '@aws-cdk/mixins-preview/aws-apigatewayv2';
declare const responseModels: any;
const cfnRouteResponseMixinProps: apigatewayv2_mixins.CfnRouteResponseMixinProps = {
apiId: 'apiId',
modelSelectionExpression: 'modelSelectionExpression',
responseModels: responseModels,
responseParameters: {
responseParametersKey: {
required: false,
},
},
routeId: 'routeId',
routeResponseKey: 'routeResponseKey',
};
Properties
| Name | Type | Description |
|---|---|---|
| api | string | The API identifier. |
| model | string | The model selection expression for the route response. |
| response | any | The response models for the route response. |
| response | IResolvable | { [string]: IResolvable | Parameter } | The route response parameters. |
| route | string | The route ID. |
| route | string | The route response key. |
apiId?
Type:
string
(optional)
The API identifier.
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 | Parameter }
(optional)
The route response parameters.
routeId?
Type:
string
(optional)
The route ID.
routeResponseKey?
Type:
string
(optional)
The route response key.

.NET
Go
Java
Python
TypeScript