interface ResponseParameterListProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.APIGatewayv2.CfnIntegration.ResponseParameterListProperty |
Java | software.amazon.awscdk.services.apigatewayv2.CfnIntegration.ResponseParameterListProperty |
Python | aws_cdk.aws_apigatewayv2.CfnIntegration.ResponseParameterListProperty |
TypeScript | @aws-cdk/aws-apigatewayv2 » CfnIntegration » ResponseParameterListProperty |
Specifies a list of response parameters for an HTTP API.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';
const responseParameterListProperty: apigatewayv2.CfnIntegration.ResponseParameterListProperty = {
responseParameters: [{
destination: 'destination',
source: 'source',
}],
};
Properties
Name | Type | Description |
---|---|---|
response | IResolvable | IResolvable | Response [] | Supported only for HTTP APIs. |
responseParameters?
Type:
IResolvable
|
IResolvable
|
Response
[]
(optional)
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 .