Interface CfnIntegration.IResponseParameterProperty
Supported only for HTTP APIs.
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface IResponseParameterProperty
Syntax (vb)
Public Interface IResponseParameterProperty
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 .
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 responseParameterProperty = new ResponseParameterProperty {
Destination = "destination",
Source = "source"
};
Synopsis
Properties
Destination | Specifies the location of the response to modify, and how to modify it. |
Source | Specifies the data to update the parameter with. |
Properties
Destination
Specifies the location of the response to modify, and how to modify it.
string Destination { get; }
Property Value
System.String
Remarks
Source
Specifies the data to update the parameter with.
string Source { get; }
Property Value
System.String