aws-cdk-lib.aws_apigatewayv2.CfnIntegration.ResponseParameterProperty

ResponseParameterProperty Struct

Supported only for HTTP APIs.

You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match the pattern <action>:<header>.<location> or overwrite.statuscode . The action can be append , overwrite or remove . The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

Source

Generated code

Type last changed

v2.154.0 · 22 Aug 2024

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';
const responseParameterProperty: apigatewayv2.CfnIntegration.ResponseParameterProperty = {
  destination: 'destination',
  source: 'source',
};

Properties

destination?optionalstringdestination?optionalstrdestination?optionalStringDestination?optionalstringDestination?optional*string#

Specifies the location of the response to modify, and how to modify it.

To learn more, see Transforming API requests and responses .

source?optionalstringsource?optionalstrsource?optionalStringSource?optionalstringSource?optional*string#

Specifies the data to update the parameter with.

To learn more, see Transforming API requests and responses .