AWS::ApiGatewayV2::Integration ResponseParameterList

Specifies a list of response parameters for an HTTP API.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ResponseParameters" : [ ResponseParameter, ... ]
}

YAML

  ResponseParameters: 
    - ResponseParameter

Properties

ResponseParameters

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.

Required: No

Type: List of ResponseParameter

Update requires: No interruption