AWS::ApiGatewayV2::Integration ResponseParameter - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ApiGatewayV2::Integration ResponseParameter

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.

Syntax

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

JSON

{
  "Destination" : String,
  "Source" : String
}

YAML

  Destination: String
  Source: String

Properties

Destination

Specifies the location of the response to modify, and how to modify it. To learn more, see Transforming API requests and responses.

Required: No

Type: String

Update requires: No interruption

Source

Specifies the data to update the parameter with. To learn more, see Transforming API requests and responses.

Required: No

Type: String

Update requires: No interruption