MethodResponse Struct
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
declare const model: apigateway.Model;
const methodResponse: apigateway.MethodResponse = {
statusCode: 'statusCode',
// the properties below are optional
responseModels: {
responseModelsKey: model,
},
responseParameters: {
responseParametersKey: false,
},
};
Properties
responseModelsoptional{ [key: string]: IModel }response_modelsoptionaltyping.Mapping[str, IModel]responseModelsoptionalMap<String, IModel>ResponseModelsoptionalIDictionary<string, IModel>ResponseModelsoptional*map[string]IModel= None#The resources used for the response's content type.
Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
responseParametersoptional{ [key: string]: boolean }response_parametersoptionaltyping.Mapping[str, bool]responseParametersoptionalMap<String, Boolean>ResponseParametersoptionalIDictionary<string, bool>ResponseParametersoptional*map[string]*bool= None#Response parameters that API Gateway sends to the client that called a method.
notes
Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value. Specify the destination using the following pattern: method.response.header.name, where the name is a valid, unique header name. The Boolean specifies whether a parameter is required.
The method response's status code, which you map to an IntegrationResponse.
Required.