Interface CfnIntegration.ResponseParameterListProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnIntegration.ResponseParameterListProperty extends
Specifies a list of response parameters for an HTTP API.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 ResponseParameterListProperty responseParameterListProperty = ResponseParameterListProperty.builder()
  • Method Details

    • getResponseParameters

      @Stability(Stable) @Nullable default Object getResponseParameters()
      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 .

    • builder

      @Stability(Stable) static CfnIntegration.ResponseParameterListProperty.Builder builder()
      a CfnIntegration.ResponseParameterListProperty.Builder of CfnIntegration.ResponseParameterListProperty