aws-cdk-lib.aws_apigateway.IntegrationResponse

IntegrationResponse Struct

Source

aws-apigateway/lib/integration.ts

Example

// 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';
const integrationResponse: apigateway.IntegrationResponse = {
  statusCode: 'statusCode',

  // the properties below are optional
  contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,
  responseParameters: {
    responseParametersKey: 'responseParameters',
  },
  responseTemplates: {
    responseTemplatesKey: 'responseTemplates',
  },
  selectionPattern: 'selectionPattern',
};

Properties

contentHandling?optionalContentHandlingcontent_handling?optionalContentHandlingcontentHandling?optionalContentHandlingContentHandling?optionalContentHandlingContentHandling?optionalContentHandling#

Specifies how to handle request payload content type conversions.

Default: none the request payload is passed through from the method request to the integration request without modification.

responseParameters?optional{ [key: string]: string }response_parameters?optionaltyping.Mapping[str, str]responseParameters?optionalMap<String, String>ResponseParameters?optionalIDictionary<string, string>ResponseParameters?optional*map[string]*string#

The response parameters from the backend response that API Gateway sends to the method response.

notes

Use the destination as the key and the source as the value:

• The destination must be an existing response parameter in the MethodResponse property.
• The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on the destination specified in the request.

responseTemplates?optional{ [key: string]: string }response_templates?optionaltyping.Mapping[str, str]responseTemplates?optionalMap<String, String>ResponseTemplates?optionalIDictionary<string, string>ResponseTemplates?optional*map[string]*string#

The templates that are used to transform the integration response body.

Specify templates as key-value pairs, with a content type as the key and a template as the value.

selectionPattern?optionalstringselection_pattern?optionalstrselectionPattern?optionalStringSelectionPattern?optionalstringSelectionPattern?optional*string#

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.

notes

For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

statusCodestringstatus_codestrstatusCodeStringStatusCodestringStatusCode*stringrequired#

The status code that API Gateway uses to map the integration response to a MethodResponse status code.