Class CfnIntegration.ResponseParameterListProperty
Specifies a list of response parameters for an HTTP API.
Inheritance
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class ResponseParameterListProperty : Object, CfnIntegration.IResponseParameterListProperty
Syntax (vb)
Public Class ResponseParameterListProperty
Inherits Object
Implements CfnIntegration.IResponseParameterListProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
var responseParameterListProperty = new ResponseParameterListProperty {
ResponseParameters = new [] { new ResponseParameterProperty {
Destination = "destination",
Source = "source"
} }
};
Synopsis
Constructors
ResponseParameterListProperty() |
Properties
ResponseParameters | Supported only for HTTP APIs. |
Constructors
ResponseParameterListProperty()
public ResponseParameterListProperty()
Properties
ResponseParameters
Supported only for HTTP APIs.
public object ResponseParameters { get; set; }
Property Value
System.Object
Remarks
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 .